Add a documentation page describing the different parts of our stack

[AetherUnbound]

Description

We have some information regarding the different aspects of our stack in the top level README.md: https://github.com/WordPress/openverse#openverse

It would be useful to have a documentation page on our docs site that goes further in-depth about the various pieces of our stack, with references to the related documentation and code for each entity (e.g. API, ingestion server, catalog, frontend).

[zealshah29]

Hi, could you describe further in detail what exactly you want in the documentation?
Like suppose if one of the tech stack is django, so do we have to explain django tech stack in detail and provide link to it's documentation?

[AetherUnbound]

Hi @zealshah29! I think it would be ideal to have the following for each section of the stack listed in the link above:

• Link to the folder for the service on GitHub
• Link to the documentation for the service on docs.openverse.org
• Primary language(s) for the project
• List of all of the tools/technologies/frameworks the services uses
  • Links to each of the above's documentation would be ideal as well

For example for the API, we'd have (respectively):

• summary of the service
• Code
• Documentation
• Language: Python
• Tools & Frameworks:
  • Django REST framework

Having a list like for each part of the stack would be excellent!

[zealshah29]

Okay, got it! So shall I create a new page in the documentation folder? or shall I create a subfolder for the same within the documentation folder?

[AetherUnbound]

Good question! I think a new page in the documentation/general folder (maybe documentation/general/stack.md?) would be the best bet! Would you like me to assign this issue to you?

[zealshah29]

Sounds great! Ya could you assign that to me? I would love to contribute.