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

[MAINTENANCE] Rename and move V17 snippets to legacy docs dir #9374

Merged
merged 34 commits into from Feb 7, 2024

Conversation

joshua-stauffer
Copy link
Member

  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses black + ruff)
  • Appropriate tests and docs have been updated

For more information about contributing, see Contribute.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

Copy link

netlify bot commented Feb 5, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit b631a8a
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/65c381a4785f820008314734
😎 Deploy Preview https://deploy-preview-9374.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ghost
Copy link

ghost commented Feb 5, 2024

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@joshua-stauffer
Copy link
Member Author

joshua-stauffer commented Feb 5, 2024

todo before this is merged:

  • delete snippet_mover.py
  • delete snippet_mover_report.py
  • remove great_expectations-0.17.23 from .gitignore

@@ -214,60 +214,3 @@
context.add_or_update_expectation_suite(
expectation_suite=test_suite,
)


# <snippet name="tests/integration/docusaurus/reference/core_concepts/result_format/result_format_checkpoint_example">
Copy link
Member Author

Choose a reason for hiding this comment

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

this deletion was a manual change - snippet (and rest of file) not used anywhere

Copy link
Contributor

Choose a reason for hiding this comment

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

@joshua-stauffer I found that the build failed without this. I think because of files that resulted from invoke api-docs. This part of the process and the gitignored directory are still pretty confusing to me

Copy link
Member Author

Choose a reason for hiding this comment

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

wow, okay, great catch!

@@ -13,7 +13,7 @@
)

# Snippet: example data frame for result_format
# <snippet name="tests/integration/docusaurus/reference/core_concepts/result_format/pandas_df_for_result_format">
Copy link
Member Author

Choose a reason for hiding this comment

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

all changes in this module were manual

@@ -0,0 +1,5 @@
Now that you've connected to your data, you'll want to work on these **core skills**:

<!-- - [How to create a Batch of data from an in-memory Spark or Pandas dataframe](/docs/guides/connecting_to_your_data/how_to_create_a_batch_of_data_from_an_in_memory_spark_or_pandas_dataframe) -->
Copy link
Member Author

Choose a reason for hiding this comment

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

@tyler-hoffman is this the link you commented out? looks like the doc only existed in 0.15

Copy link
Contributor

Choose a reason for hiding this comment

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

It did -- this link should have been removed or updated by one of my PRs for the current docs, but at the time that this doc was current the 0.15.x docs were still supported so some links back to them remained for features that didn't have an equivalent any more in 0.17.x.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm pretty sure this entire file was removed in PR 9355

@@ -19,7 +19,7 @@ To configure a Data Context for a specific environment, see one of the following

## Create Expectation Suites and add Expectations

To add a Data Source and an Expectation Suite, see [How to connect to a PostgreSQL database](/guides/connecting_to_your_data/database/connect_sql_source_data.md?sql-database-type=postgresql).
To add a Data Source and an Expectation Suite, see [How to connect to a PostgreSQL database](/guides/connecting_to_your_data/fluent/database/connect_sql_source_data.md?sql-database-type=postgresql).
Copy link
Member Author

Choose a reason for hiding this comment

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

this change surprises me - was it broken before? or did we move the file?

Copy link
Contributor

Choose a reason for hiding this comment

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

The original link points to a block-config version of the same content, I believe. Pretty sure it will end up redirecting to the 0.15.x docs, since that content wasn't pulled forward into the more recent versions. The fluent link is correct.

@joshua-stauffer joshua-stauffer added this pull request to the merge queue Feb 7, 2024
Merged via the queue into develop with commit feddf40 Feb 7, 2024
60 checks passed
@joshua-stauffer joshua-stauffer deleted the m/v1-153/rename_v17_doc_snippets branch February 7, 2024 14:29
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

4 participants