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]: Port over "How to instantiate a Data Context w/o YML" from RTD to Docusaurus #3011

Conversation

cdkini
Copy link
Member

@cdkini cdkini commented Jul 9, 2021

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:

  • Port over .rst guide to .md

After submitting your PR, CI checks will run and @tiny-tim-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.

  • My code follows the Great Expectations style guide
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests where applicable and made sure that new and existing tests are passing.
  • I have run any local integration tests and made sure that nothing is broken.

Thank you for submitting!

@netlify
Copy link

netlify bot commented Jul 9, 2021

✔️ Deploy Preview for knoxpod ready!

🔨 Explore the source changes: 79fdad8

🔍 Inspect the deploy log: https://app.netlify.com/sites/knoxpod/deploys/60e8c3b7976d160008b6901a

😎 Browse the preview: https://deploy-preview-3011--knoxpod.netlify.app

@github-actions
Copy link
Contributor

github-actions bot commented Jul 9, 2021

HOWDY! This is your friendly 🤖 CHANGELOG bot 🤖

Please don't forget to add a clear and succinct description of your change under the Develop header in docs/changelog.rst, if applicable. This will help us with the release process. See the Contribution checklist in the Great Expectations documentation for the type of labels to use!

Thank you!

cdkini added 4 commits July 9, 2021 14:00
…_context_wo_yml' of github.com:great-expectations/great_expectations into DOCS/GDOC-107/GDOC-58/port_over_how_to_instantiate_data_context_wo_yml
@cdkini cdkini changed the title [DOCS]: Port over "H ow to instantiate a Data Context w/o YML" from RTD to Docusaurus [DOCS]: Port over "How to instantiate a Data Context w/o YML" from RTD to Docusaurus Jul 9, 2021

Here we will show a few examples of common configurations, using the ``store_backend_defaults`` parameter. Note that you can continue with the existing API sans defaults by omitting this parameter, and you can override all of the parameters as shown in the last example. Note that a parameter set in ``DataContextConfig`` will override a parameter set in ``store_backend_defaults`` if both are used.

**TODO(cdkini): These are links to our API Reference, which has not yet been implemented. What should we do here?**
Copy link
Member Author

Choose a reason for hiding this comment

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

Please note this TODO here and below.

Copy link
Member Author

@cdkini cdkini left a comment

Choose a reason for hiding this comment

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

Screenshot 2021-07-09 at 14-06-39 How to instantiate a Data Context without a yml file — great_expectations documentation
Screenshot 2021-07-09 at 14-06-19 How to instantiate a Data Context without a yml file Great Expectations


If you are using Airflow, you may wish to pass this Data Context to your GreatExpectationsOperator as a parameter. See the following guide for more details:

- [Deploying Great Expectations with Airflow](../../../guides/w) - **TODO(cdkini): Where do we link this?**
Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@alexsherstinsky alexsherstinsky left a comment

Choose a reason for hiding this comment

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

LGTM

@cdkini cdkini enabled auto-merge (squash) July 9, 2021 21:46
@cdkini cdkini merged commit bcfb023 into develop Jul 9, 2021
@cdkini cdkini deleted the DOCS/GDOC-107/GDOC-58/port_over_how_to_instantiate_data_context_wo_yml branch July 9, 2021 21:47
pasmavie pushed a commit to pasmavie/great_expectations that referenced this pull request Jul 13, 2021
…TD to Docusaurus (great-expectations#3011)

* docs: Port over guide from RTD to Docusaurus
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.

2 participants