Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Docs/doc 95/doc 129/technical term tags for setup pages #4392

Merged

Conversation

Rachel-Reverie
Copy link
Contributor

Please annotate your PR title to describe what the PR does, then give a brief bulleted description of your PR below. PR titles should begin with [BUGFIX], [FEATURE], [DOCS], or [MAINTENANCE]. If a new feature introduces breaking changes for the Great Expectations API or configuration files, please also add [BREAKING]. You can read about the tags in our contributor checklist.

Changes proposed in this pull request:

  • Adds technical term tags to all of the documents under the Step 1: Setup section of the ToC.
  • Corrects formatting issues with how-to guides under the Step 1: Setup section of the ToC to bring them in line with our standards defined in the "how to write a how-to guide" documentation.

After submitting your PR, CI checks will run and @ge-cla-bot will check for your CLA signature.

For a PR with nontrivial changes, we review with both design-centric and code-centric lenses.

In a design review, we aim to ensure that the PR is consistent with our relationship to the open source community, with our software architecture and abstractions, and with our users' needs and expectations. That review often starts well before a PR, for example in github issues or slack, so please link to relevant conversations in notes below to help reviewers understand and approve your PR more quickly (e.g. closes #123).

Previous Design Review notes:

Definition of Done

Please delete options that are not relevant.

  • I have made corresponding changes to the documentation

Thank you for submitting!

- Added technical term tags to all docs in /docs/guides/setup/configuring_data_docs
- Added technical term tags to all docs in /docs/guides/setup/configuring_data_contexts
…existing tags with "relative" will just disregard that parameter.)

- Updates to technical term tags in both documents.
- Updates to standardize formating in both documents (indentation was confusing the markdown render's unordered lists.)
- Edited "Validations" to be "Validation Results"; minor corrections to title casing of technical terms.
@netlify
Copy link

netlify bot commented Mar 11, 2022

✔️ Deploy Preview for niobium-lead-7998 ready!

🔨 Explore the source changes: 85b6e42

🔍 Inspect the deploy log: https://app.netlify.com/sites/niobium-lead-7998/deploys/62320e47169d2000082026f6

😎 Browse the preview: https://deploy-preview-4392--niobium-lead-7998.netlify.app

Copy link
Member

@anthonyburdi anthonyburdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to review the first 8 files, have to jump into a meeting but submitting comments so far before I can get back to this in case they are helpful.

Rachel-Reverie and others added 2 commits March 14, 2022 13:35
…redentials.md

Co-authored-by: Anthony Burdi <anthony@superconductive.com>
…data_docs_on_azure_blob_storage.md

Co-authored-by: Anthony Burdi <anthony@superconductive.com>
Copy link
Member

@anthonyburdi anthonyburdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few minor nitpicks but otherwise LGTM!


```bash file=../../../../tests/integration/docusaurus/setup/configuring_metadata_stores/how_to_configure_an_expectation_store_in_gcs.py#L155-L161
```
Run the following:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Rachel-Reverie and others added 2 commits March 16, 2022 09:14
Co-authored-by: Anthony Burdi <anthony@superconductive.com>
@Rachel-Reverie
Copy link
Contributor Author

@anthonyburdi All of your suggestions looked good, and I've incorporated all of them into the update. When you have a moment, please revisit your review. Thanks!

Copy link
Member

@anthonyburdi anthonyburdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you for making those updates 🙇

@Rachel-Reverie Rachel-Reverie merged commit d929ef9 into develop Mar 16, 2022
@Rachel-Reverie Rachel-Reverie deleted the DOCS/DOC-95/DOC-129/technical_term_tags_for_setup_pages branch March 16, 2022 16:21
Shinnnyshinshin pushed a commit that referenced this pull request Mar 17, 2022
…est-runner

* develop: (207 commits)
  [FEATURE] Rule-Based Profiler: Implement semantic type logic for all DomainBuilder (#4446)
  Update tutorial_review.md (#3981)
  [BUGFIX] Ensure that atomic prescriptive renderers have proper `mostly_pct` param in payload (#4438)
  [MAINTENANCE] Update broken snippet threshold in embedded Docusaurus reference validation script
  [FEATURE] Notebooks for RBP Examples (#4396)
  updated release candidate for 0.14.11 (#4454)
  [BUGFIX] Fix packaging test
  [BUGFIX] Removes potentially sensitive webhook URLs from logging (#4440)
  release candidate for 0.14.11 (#4448)
  Add any dependencies we import directly, but don't have as explicit requirements (#4447)
  [FEATURE] Rule-Based Profiler: Implement Utilities for getting all available parameter node names and objects resident in memory (#4442)
  [MAINTENANCE] Clean up of `RegexPatternStringParameterBuilder` tests to use unittests (#4436)
  [DOCS] Creates Custom Table Expectation How-To (#4399)
  [DOCS] technical terms create expectations: core skills (#4435)
  [DOCS] Add misc `<snippet>` tags to existing documentation (#4397)
  - Adds technical tags to all documents in the Connect to data: in-memory section of the docs. (#4405)
  - Adds technical tags to all documents in the Connect to data: Advanced section of the docs. (#4406)
  updates or deletes broken notebooks (#4404)
  [MAINTENANCE] Set upper bound on number of allowed warnings in snippet validation script
  [DOCS] Docs/doc 95/doc 129/technical term tags for setup pages (#4392)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants