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

Add shim README.md files in project directories #3231

Merged
merged 14 commits into from
Oct 20, 2023
4 changes: 4 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Django API

This service is documented at
[docs.openverse.org/api](https://docs.openverse.org/api/index.html).
4 changes: 4 additions & 0 deletions automations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Automations

This service is documented at
[docs.openverse.org/automations](https://docs.openverse.org/automations/index.html).
4 changes: 4 additions & 0 deletions catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Airflow Catalog

This service is documented at
[docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html).
4 changes: 4 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Documentation

This service is documented at
[docs.openverse.org/documentation](https://docs.openverse.org/meta/documentation/index.html).
2 changes: 1 addition & 1 deletion documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Nuxt frontend

This service is documented at
[docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html).
4 changes: 4 additions & 0 deletions ingestion_server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ingestion server

This service is documented at
[docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html).
4 changes: 4 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Node.js packages

This service is documented at
[docs.openverse.org/packages](https://docs.openverse.org/packages/index.html).
3 changes: 2 additions & 1 deletion packages/eslint-plugin/README.md
Original file line number Diff line number Diff line change
@@ -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).