[DOCS] remove unsupported actions #10624
Conversation
✅ Deploy Preview for niobium-lead-7998 canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## develop #10624 +/- ##
===========================================
- Coverage 80.31% 80.31% -0.01%
===========================================
Files 463 463
Lines 40120 40117 -3
===========================================
- Hits 32223 32220 -3
Misses 7897 7897
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…tions/great_expectations into kml/DOC-844/removeActions2
| @@ -352,7 +352,6 @@ def _send_slack_notification(self, payload: dict) -> dict: | |||
| return {"slack_notification_result": slack_notif_result} | |||
|
|
|||
|
|
|||
| @public_api | |||
There was a problem hiding this comment.
Are these actions no longer GX support or no longer community supported either?
That is, do we want community supported actions in our public docs and labeled as such or not appearing at all.
If these aren't community supported, can we delete the actions altogether?
There was a problem hiding this comment.
Are these actions no longer GX support or no longer community supported either?
These actions are unsupported by GX and unsupported by the community (source of truth for integration support is https://docs.greatexpectations.io/docs/application_integration_support#integrations)
If these aren't community supported, can we delete the actions altogether?
Yes, but that's outside the scope of this docs PR. I filed https://greatexpectations.atlassian.net/browse/CORE-600 for this and product/eng can then prioritize as y'all see fit (I'm not sure how impactful the tech debt is / if it's worth your time to clean it up or easier to just leave it in place in case product decides we should support these integrations in the future)
There was a problem hiding this comment.
We should always remove dead code.
There was a problem hiding this comment.
Thinking about this more, maybe we need to leave the code in for semantic versioning. Removing the public api decorator will necessitate a minor version bump.
docs/docusaurus/static/_redirects
Outdated
| @@ -73,7 +73,7 @@ http://legacy.016.docs.greatexpectations.io/* http://docs.greatexpectations.io 3 | |||
| /en/latest/guides/how_to_guides/miscellaneous/how_to_template.html https://legacy.docs.greatexpectations.io/en/latest/guides/how_to_guides/miscellaneous/how_to_template.html | |||
| /en/latest/guides/how_to_guides/miscellaneous/how_to_add_and_test_a_new_sqlalchemydataset_class.html https://legacy.docs.greatexpectations.io/en/latest/guides/how_to_guides/miscellaneous/how_to_add_and_test_a_new_sqlalchemydataset_class.html | |||
| /en/latest/guides/how_to_guides/miscellaneous/how_to_use_official_docker_images.html https://legacy.docs.greatexpectations.io/en/latest/guides/how_to_guides/miscellaneous/how_to_use_official_docker_images.html | |||
| /en/latest/guides/how_to_guides/miscellaneous/how_to_setup_opsgenie_alert_notifications.html https://legacy.docs.greatexpectations.io/en/latest/guides/how_to_guides/miscellaneous/how_to_setup_opsgenie_alert_notifications.html | |||
| /en/latest/guides/how_to_guides/miscellaneous/how_to_setup_opsgenie_alert_notifications.html /docs/0.18/reference/api/checkpoint/opsgeniealertaction_class/ | |||
There was a problem hiding this comment.
Why aren't we completely removing opgenie here if it is not supported? Is it because the code still exists? When we remove that code, will we have to remove this code and update this file again?
There was a problem hiding this comment.
That is, if we need to remove it later, could you add this to the ticket you filed, CORE-600?
There was a problem hiding this comment.
hmmm good point! I forgot this part of our support posture -https://docs.greatexpectations.io/docs/application_integration_support#gx-versions - I'll revise this redirect
tests/checkpoint/test_checkpoint.py
Outdated
| data_docs_action = UpdateDataDocsAction(name="my_docs_action") | ||
| actions: List[CheckpointAction] = [pd_action, og_action, data_docs_action] | ||
| actions: List[CheckpointAction] = [data_docs_action] |
There was a problem hiding this comment.
This test is suppose to verify sorting actions. If there is only 1 action, this test is no longer verifying this. Could you add actions to replace the ones you removed?
There was a problem hiding this comment.
I'll try! But I'm definitely out of my comfort zone here so if the update I make doesn't do the trick I'd love to pair on this
There was a problem hiding this comment.
Thanks for doing this! Happy to pair.
| @@ -827,4 +827,19 @@ | |||
| name="get_batch_parameters_keys", | |||
| filepath=pathlib.Path("great_expectations/datasource/fluent/sql_datasource.py"), | |||
| ), | |||
| IncludeExcludeDefinition( | |||
There was a problem hiding this comment.
If we were to remove the unsupported actions would we have to undo this change and remove these?
There was a problem hiding this comment.
If so, could you add it as a task to do in CORE-600?
There was a problem hiding this comment.
If we were to remove the unsupported actions would we have to undo this change and remove these?
I assume yes, but I'm not 100% confident in my understanding of how the api docs get built
If so, could you add it as a task to do in CORE-600?
yes, will do!
There was a problem hiding this comment.
@klavavej the api docs build is complex. I'm happy to chat about it.
resolves https://greatexpectations.atlassian.net/browse/DOC-844 - removes unsupported actions from the API docs (opsgenie, pagerduty, SNS)
I'm leaving
UpdateDataDocsActionandValidationActionin place as I assume those are supported and the ticket was about third party integrations that aren’t currently supported. Let me know if I’m wrong thoughinvoke lint(usesruff format+ruff check)For more information about contributing, visit our community resources.
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!