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

Added documentations for how to run DAGs in development alongside how to add new documentations. #4388

Conversation

madewithkode
Copy link
Collaborator

@madewithkode madewithkode commented May 26, 2024

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

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (just catalog/generate-docs for catalog
    PRs) 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
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@madewithkode madewithkode requested a review from a team as a code owner May 26, 2024 13:55
@madewithkode madewithkode requested review from krysal and dhruvkb May 26, 2024 13:55
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed 🌟 goal: addition Addition of new feature 🤖 aspect: dx Concerns developers' experience with the codebase 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🏷 status: label work required Needs proper labelling before it can be worked on labels May 26, 2024
@madewithkode madewithkode force-pushed the 4356_create_a_document_for_how_to_start_the_catalog_stack_and_run_a_dag_for_testing branch from 1eb66f9 to ad5da86 Compare May 26, 2024 14:04
@dhruvkb dhruvkb requested review from a team and obulat and removed request for dhruvkb and a team May 27, 2024 06:24
@dhruvkb dhruvkb added 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧱 stack: documentation Related to Sphinx documentation and removed 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels May 27, 2024
Copy link
Collaborator

@AetherUnbound AetherUnbound left a 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 🙌🏼

documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/catalog/guides/dag_testing.md Outdated Show resolved Hide resolved
documentation/meta/documentation/adding_docs.md Outdated Show resolved Hide resolved
documentation/meta/documentation/adding_docs.md Outdated Show resolved Hide resolved
@madewithkode madewithkode force-pushed the 4356_create_a_document_for_how_to_start_the_catalog_stack_and_run_a_dag_for_testing branch from ad5da86 to c967314 Compare May 28, 2024 10:18
Copy link
Contributor

@obulat obulat left a 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
Copy link
Contributor

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

Copy link
Collaborator

@AetherUnbound AetherUnbound left a 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!

@AetherUnbound AetherUnbound merged commit a9b02c7 into WordPress:main May 28, 2024
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Create a document for how to start the catalog stack and run a DAG for testing
5 participants