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

[dagster-aws, docs] cloudwatch message reader docs #23440

Merged
merged 2 commits into from
Aug 16, 2024

Conversation

danielgafni
Copy link
Contributor

@danielgafni danielgafni commented Aug 6, 2024

Summary & Motivation

Adding docs for the new PipesCloudWatchMessageReader

How I Tested These Changes

Copy link
Contributor Author

danielgafni commented Aug 6, 2024

@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch from dc0da1c to cf82b96 Compare August 6, 2024 16:17
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch from a40c740 to a4f6654 Compare August 6, 2024 16:17
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch from cf82b96 to 6021a9f Compare August 7, 2024 13:47
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch from a4f6654 to 739c892 Compare August 7, 2024 13:47
@danielgafni danielgafni marked this pull request as ready for review August 7, 2024 13:53
@graphite-app graphite-app bot added the area: docs Related to documentation in general label Aug 7, 2024
@danielgafni danielgafni changed the title cloudwatch message reader docs [dagster-aws, docs] cloudwatch message reader docs Aug 7, 2024
@cmpadden cmpadden force-pushed the pipes-cloudwatch-message-reader branch from 6021a9f to 89ec8ce Compare August 7, 2024 15:21
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch from 89ec8ce to 3cf6d49 Compare August 7, 2024 15:39
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch 2 times, most recently from 173591b to 03bf062 Compare August 7, 2024 16:13
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch from 3cf6d49 to af7fce7 Compare August 7, 2024 19:52
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch 2 times, most recently from 15202bc to 0c307aa Compare August 7, 2024 21:30
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch from af7fce7 to afe07d1 Compare August 8, 2024 09:01
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader branch 2 times, most recently from e22ac4e to 430d2bf Compare August 8, 2024 16:02
Base automatically changed from pipes-cloudwatch-message-reader to master August 8, 2024 17:25
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch 2 times, most recently from e1a2c73 to 3c0b654 Compare August 8, 2024 19:52
Copy link
Contributor

@erinkcochran87 erinkcochran87 left a comment

Choose a reason for hiding this comment

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

Sending this back over to you. I'm looking into the comment you tagged me in, but didn't want you to wait on me for the other stuff.

docs/content/concepts/dagster-pipes/aws-glue.mdx Outdated Show resolved Hide resolved
docs/content/concepts/dagster-pipes/aws-glue.mdx Outdated Show resolved Hide resolved
python_modules/libraries/dagster-aws/dagster_aws/pipes.py Outdated Show resolved Hide resolved
python_modules/libraries/dagster-aws/dagster_aws/pipes.py Outdated Show resolved Hide resolved
python_modules/libraries/dagster-aws/dagster_aws/pipes.py Outdated Show resolved Hide resolved
@danielgafni
Copy link
Contributor Author

@erinkcochran87 another puzzle from Sphinx - do you know why this PipesGlueClient class reference here doesn't get a proper URL? It points to the current page.

image

These two which seem to be created the same way work correctly (they point to API docs).

image

@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch from 8e5de4c to a9842e4 Compare August 10, 2024 14:16
Copy link

vercel bot commented Aug 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dagster-docs-next ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 10, 2024 2:16pm

@cmpadden
Copy link
Contributor

@erinkcochran87 another puzzle from Sphinx - do you know why this PipesGlueClient class reference here doesn't get a proper URL? It points to the current page.

image

These two which seem to be created the same way work correctly (they point to API docs).

image

This is because :noindex: was provided in the Sphinx rst file, this can be resolved by updating it like so:

diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-aws.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-aws.rst
index 0e2969447d..078144abce 100644
--- a/docs/sphinx/sections/api/apidocs/libraries/dagster-aws.rst
+++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-aws.rst
@@ -119,8 +119,6 @@ Clients
 .. autoclass:: dagster_aws.pipes.PipesLambdaClient

 .. autoclass:: dagster_aws.pipes.PipesGlueClient
-   :noindex:
-   :members: run

 Legacy
 --------

@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch 2 times, most recently from 79d16ab to b46fe9b Compare August 16, 2024 15:54
danielgafni and others added 2 commits August 16, 2024 16:09
Co-authored-by: Erin Cochran <erin.k.cochran@gmail.com>
@danielgafni danielgafni force-pushed the pipes-cloudwatch-message-reader-docs branch from b46fe9b to 1a2da02 Compare August 16, 2024 16:09
Copy link
Contributor Author

danielgafni commented Aug 16, 2024

Merge activity

  • Aug 16, 12:10 PM EDT: Graphite rebased this pull request as part of a merge.
  • Aug 16, 12:11 PM EDT: @danielgafni merged this pull request with Graphite.

@danielgafni danielgafni merged commit 206ad6e into master Aug 16, 2024
1 of 2 checks passed
@danielgafni danielgafni deleted the pipes-cloudwatch-message-reader-docs branch August 16, 2024 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants