-
Notifications
You must be signed in to change notification settings - Fork 212
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
Added documentations for how to run DAGs in development alongside how to add new documentations. #4388
Conversation
1eb66f9
to
ad5da86
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@madewithkode thank you for this awesome contribution, and for going above the issue's requirements to also add a "new documentation" page 😄 I just have a few suggestions on wording and formatting, but this is such a great PR. We really appreciate the effort you've taken here 🙌🏼
… to add new documentation
ad5da86
to
c967314
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for very helpful instructions, @madewithkode, amazing contribution ✨
[our quickstart guide](/catalog/guides/quickstart.md#api-data). This document | ||
describes how to run or test out these DAGs locally during development. | ||
|
||
Additionally, it is worth noting that not all DAGs can be run locally in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess it would be more accurate to say
"to run some DAGs locally, you might need to get the API keys from the provider and add them to the catalog/.env
file". Because you can run the DAGs if you add the keys to the .env
file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, I made one change to the formatting on the note at the end because I realized the suggestion I provided wasn't using proper MyST syntax. Sorry about that! And thanks for the contribution!
Fixes
Fixes #4356 by @AetherUnbound
Description
This PR seeks to add a documentation on how to run DAGs in development.
This PR also adds a new documentation on how to add new documentations.
Testing Instructions
just documentation/live
Checklist
Update index.md
).main
) or a parent feature branch.just catalog/generate-docs
for catalogPRs) or the media properties generator (
just catalog/generate-docs media-props
for the catalog or
just api/generate-docs
for the API) where applicable.Developer Certificate of Origin
Developer Certificate of Origin