Giters

WordPress / openverse

Openverse is a search engine for openly-licensed media. This monorepo includes all application code.

Home Page:https://openverse.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

AetherUnbound opened this issue · comments

commented

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)

commented

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.

commented

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:

    openverse/documentation/catalog/guides/index.md

    Line 9 in a144002

    deployment
    ).
  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!

commented

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