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

Create a document for how to start the catalog stack and run a DAG for testing #4356

Closed
AetherUnbound opened this issue May 17, 2024 · 3 comments · Fixed by #4388
Closed
Assignees
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: documentation Related to Sphinx documentation 🔧 tech: airflow Involves Apache Airflow

Comments

@AetherUnbound
Copy link
Contributor

Description

It would be useful to have a document we could point new contributors to that describes how to run the catalog stack, navigate to Airflow, and start a DAG. This could include a few suggestions of DAGs to run (i.e. DAGs which do not require API keys), like the ones for SMK or Finnish Museums. It should include screenshots and the instructions should not require knowledge of Airflow in order to execute.

This comment can be used as a basis for the document: #4216 (comment)

@AetherUnbound AetherUnbound added 🌟 goal: addition Addition of new feature 🔧 tech: airflow Involves Apache Airflow 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: documentation Related to Sphinx documentation labels May 17, 2024
@madewithkode
Copy link
Contributor

Hi @AetherUnbound I'd like to take on this. It's funny that I'd have to ask a similar question on how to make changes to the documentation 😅
Is there like a doc you can point me too or perhaps an overview of the steps required.

@AetherUnbound
Copy link
Contributor Author

Ha, great question! Our documentation-documentation is available here: https://docs.openverse.org/meta/documentation/index.html#documentation. The quick start should be particularly useful! That said, we don't have a document specific to creating a new documentation page. If you're up for tackling that as part of this work, that'd be extremely helpful! No pressure though 😄 The process will look like this:

  1. Create a markdown file at a place within the documentation/ hierarchy that makes the most sense.
  2. Make sure that the file is present in the closest index.md file (usually alongside the file itself). For instance, a new file dag_testing.md in documentation/catalog/guides/ would need an entry in documentation/catalog/guides/index.md with the name of the document (so this example would add dag_testing here: ).
  3. Write the document using MyST flavored Markdown.
  4. Run just lint to make sure the document is formatted.
  5. Run just documentation/live locally (following the quick start guide) and navigate to the new page to make sure it looks okay!

That should be it, feel free to ask here or in Slack if you have any other questions about that process!

@madewithkode
Copy link
Contributor

Thanks for the rundown! This should be enough to get started.

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: documentation Related to Sphinx documentation 🔧 tech: airflow Involves Apache Airflow
Projects
Status: ✅ Done
2 participants