Add a documentation page describing the different parts of the Openverse stack #3786
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,50 @@ | ||||||
| # Stack | ||||||
|
|
||||||
| This page is your gateway to understanding our diverse technology stack. Explore code repositories on GitHub, access detailed documentation, and learn about the tools, frameworks, and languages driving each stack of the Openverse platform. | ||||||
|
|
||||||
| 1. Catalog | ||||||
| - Powered by Apache Airflow, it stores Openverse metadata efficiently. | ||||||
| - [Code](https://github.com/WordPress/openverse/blob/main/catalog) | ||||||
| - [Documentation](https://docs.openverse.org/catalog/index.html) | ||||||
| - Language: Python | ||||||
| - Tools and Framework: | ||||||
| - [Apache Airflow](https://airflow.apache.org/docs/apache-airflow-providers-google/stable/operators/cloud/datacatalog.html) | ||||||
| 2. Ingestion Server | ||||||
| - The mechanism for refreshing the data from the catalog to the API. | ||||||
| - [Code](https://github.com/WordPress/openverse/blob/main/ingestion_server) | ||||||
| - [Documentation](https://docs.openverse.org/ingestion_server/index.html) | ||||||
| - Language: Python | ||||||
| - Tools and Framework: | ||||||
| - [Elasticsearch](https://www.elastic.co/guide/index.html) | ||||||
stacimc marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - [Docker](https://docs.docker.com/) | ||||||
|
There was a problem hiding this comment. Docker is basically a dev + deployment mechanism and not a part of the stack's technologies so I recommend dropping that. |
||||||
| 3. API | ||||||
| - Built with Django REST, it enables database querying for the Frontend. | ||||||
| - [Code](https://github.com/WordPress/openverse/blob/main/api) | ||||||
| - [Documentation](https://docs.openverse.org/api/index.html) | ||||||
| - Language: Python | ||||||
| - Tools and Framework: | ||||||
| - [Django REST Framework](https://www.django-rest-framework.org/) | ||||||
|
There was a problem hiding this comment. Also include Django above this. There was a problem hiding this comment. Shall I add it to line number 25? There was a problem hiding this comment. Yes, that would be great, thanks! There was a problem hiding this comment. @dhruvkb do you have an opinion about the docs links being pinned to a version? (5.0 in this case?) Not sure there's anything we can do about that 🤔 There was a problem hiding this comment. Do I need to make any changes related to the link over here? |
||||||
| - [Docker](https://docs.docker.com/) | ||||||
| 4. Frontend | ||||||
| - The public search engine at [openverse.org](https://openverse.org/), built with Vue and Nuxt. | ||||||
| - [Code](https://github.com/WordPress/openverse/blob/main/frontend) | ||||||
| - [Documentation](https://docs.openverse.org/frontend/index.html) | ||||||
| - Language: JavaScript, HTML, CSS | ||||||
|
There was a problem hiding this comment. HTML and CSS are kind-of universal to frontend dev so we can skip them. Also TypeScript is more appropriate here.
Suggested change
|
||||||
| - Tools and Framework: | ||||||
| - [Nuxt.js](https://nuxt.com/docs/getting-started/introduction) | ||||||
| - [Vue.js](https://vuejs.org/guide/introduction.html) | ||||||
| - [Node.js](https://nodejs.org/docs/latest/api/) | ||||||
| - [Tailwind CSS](https://v2.tailwindcss.com/docs) | ||||||
|
There was a problem hiding this comment. Node.js is neither a tool nor a framework. It's a JS runtime, so it feels incorrect to list here. As for TailwindCSS, it is a very small, not-noteworthy slice of the number of technologies we use in the frontend. |
||||||
| 5. Automation | ||||||
| - Scripts used for various workflows around Openverse repositories and processes. | ||||||
| - [Code](https://github.com/WordPress/openverse/tree/main/automations) | ||||||
| - [Documentation](https://docs.openverse.org/automations/index.html) | ||||||
| - Language: Python | ||||||
| - Tools and Framework: | ||||||
| - [Node.js](https://nodejs.org/docs/latest/api/) | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
There was a problem hiding this comment. These blank lines should be removed as the lint job in CI will complain. |
||||||
Uh oh!
There was an error while loading. Please reload this page.