Add shim README.md files in project directories (#3231)

Co-authored-by: Olga Bulat <[email protected]>
Co-authored-by: Dhruv Bhanushali <[email protected]>

api/README.md

@@ -0,0 +1,4 @@
+# Django API
+
+This service is documented at
+[docs.openverse.org/api](https://docs.openverse.org/api/index.html).

automations/README.md

@@ -0,0 +1,4 @@
+# Automations
+
+This service is documented at
+[docs.openverse.org/automations](https://docs.openverse.org/automations/index.html).

catalog/README.md

@@ -0,0 +1,4 @@
+# Airflow Catalog
+
+This service is documented at
+[docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html).

documentation/README.md

@@ -0,0 +1,4 @@
+# Documentation
+
+This service is documented at
+[docs.openverse.org/documentation](https://docs.openverse.org/meta/documentation/index.html).

documentation/conf.py

@@ -40,7 +40,7 @@ def add_ext_to_path():
 
 source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
 
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv", "README.md"]
 suppress_warnings = [
     # Pygments does not fully support language features we use
     # in code blocks in the documentation. Unfortunately the best

frontend/README.md

@@ -0,0 +1,4 @@
+# Nuxt frontend
+
+This service is documented at
+[docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html).

ingestion_server/README.md

@@ -0,0 +1,4 @@
+# Ingestion server
+
+This service is documented at
+[docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html).

packages/README.md

@@ -0,0 +1,4 @@
+# Node.js packages
+
+This service is documented at
+[docs.openverse.org/packages](https://docs.openverse.org/packages/index.html).

packages/eslint-plugin/README.md

@@ -1,3 +1,4 @@
 # `@openverse/eslint-plugin`
 
-Refer to <https://docs.openverse.org/packages/eslint_plugin> for documentation.
+This service is documented at
+[docs.openverse.org/packages/eslint_plugin](https://docs.openverse.org/packages/eslint_plugin).