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

[embedded-elt] Update Sling docs and examples #20028

Merged
merged 7 commits into from
Feb 29, 2024
Merged

Conversation

PedramNavid
Copy link
Contributor

@PedramNavid PedramNavid commented Feb 25, 2024

Summary & Motivation

Updates Sling docs to use new API, deprecating the old one.
I moved the Relevant API section to the bottom as well, for an easier flow.

How I Tested These Changes

@PedramNavid PedramNavid marked this pull request as draft February 25, 2024 23:34
@PedramNavid PedramNavid force-pushed the pdrm/sling-docs-v2 branch 3 times, most recently from 2fa56e2 to e6858f8 Compare February 27, 2024 06:38
@PedramNavid PedramNavid marked this pull request as ready for review February 27, 2024 06:38
docs/content/_apidocs.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Show resolved Hide resolved
@PedramNavid PedramNavid force-pushed the pdrm/sling-deprecate branch 2 times, most recently from a2a19d4 to 071fb51 Compare February 28, 2024 03:26
Base automatically changed from pdrm/sling-deprecate to master February 28, 2024 03:46
Copy link

Deploy preview for dagster-university ready!

✅ Preview
https://dagster-university-7g4p52cz7-elementl.vercel.app
https://pdrm-sling-docs-v2.dagster-university.dagster-docs.io

Built with commit 4b969e6.
This pull request is being automatically deployed with vercel-action

Copy link

Deploy preview for dagit-core-storybook ready!

✅ Preview
https://dagit-core-storybook-9dwqqmdo3-elementl.vercel.app
https://pdrm-sling-docs-v2.core-storybook.dagster-docs.io

Built with commit 4b969e6.
This pull request is being automatically deployed with vercel-action

Copy link

Deploy preview for dagit-storybook ready!

✅ Preview
https://dagit-storybook-b7oa6geu5-elementl.vercel.app
https://pdrm-sling-docs-v2.components-storybook.dagster-docs.io

Built with commit 4b969e6.
This pull request is being automatically deployed with vercel-action

@PedramNavid PedramNavid force-pushed the pdrm/sling-docs-v2 branch 2 times, most recently from 7ba4952 to 0d09a7b Compare February 28, 2024 04:29
Refactor documentation for the 'embedded-elt' and 'sling' APIs for improved readability and clarity.
Add code snippets and API usage examples, correct hyperlink references,
and adjust API definitions to match their actual usage within the python modules.
Also, deprecate 'build_sling_asset' function and use '@public' decorators to indicate public methods.

docs: update documentation for Dagster Embedded ELT

Updated the documentation for the Sling implementation of the Embedded ELT package to reflect changes to the way connections and replication configurations are setup. Also simplified examples and provided more detailed instructions for setting up resources, assets, and replication configurations.

Improved inline code examples by adhering to code standards and removed the use of os to get environment variables, instead using `EnvVar`.

docs: update embedded ELT and api documentation

- Corrected the description of the embedded ELT feature in _apidocs.mdx
- Added details on configuration, credential management and resource creation for the Sling integration in embedded-elt.mdx

docs: update embedded ELT and api documentation

- Corrected the description of the embedded ELT feature in _apidocs.mdx
- Added details on configuration, credential management and resource creation for the Sling integration in embedded-elt.mdx

Revert
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
docs/content/integrations/embedded-elt.mdx Outdated Show resolved Hide resolved
Subdivided examples into 'Database to Database' and 'File to Database'.
@PedramNavid PedramNavid merged commit 2cabe87 into master Feb 29, 2024
2 checks passed
@PedramNavid PedramNavid deleted the pdrm/sling-docs-v2 branch February 29, 2024 04:20
shalabhc pushed a commit that referenced this pull request Feb 29, 2024
## Summary & Motivation

Updates Sling docs to use new API, deprecating the old one.
PedramNavid added a commit that referenced this pull request Mar 28, 2024
## Summary & Motivation

Updates Sling docs to use new API, deprecating the old one.
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

3 participants