From ac9213d9f102bff4701da16ed2b8930e502174b5 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 14:03:11 +0300 Subject: [PATCH 01/13] Create README.md Shim README files added to the catalog sub folder that point to the documentation site. --- catalog/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 catalog/README.md diff --git a/catalog/README.md b/catalog/README.md new file mode 100644 index 00000000000..22bd6842114 --- /dev/null +++ b/catalog/README.md @@ -0,0 +1,3 @@ +# Catalog Service + +This service is documented at [docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html). From d7d322a033d9bd9fda9d92ac473011f54c19870d Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 14:05:52 +0300 Subject: [PATCH 02/13] Create README.md Shim README files added to the api subfolders that point to the documentation site. --- api/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 api/README.md diff --git a/api/README.md b/api/README.md new file mode 100644 index 00000000000..aaa3cd12658 --- /dev/null +++ b/api/README.md @@ -0,0 +1,3 @@ +# API Service + +This service is documented at [docs.openverse.org/api](https://docs.openverse.org/api/index.html). From 519d6ca37dde4dc42a1320024287b95aff15baaf Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 14:10:55 +0300 Subject: [PATCH 03/13] Update README.md README file Updated to the `Shim README` file that point to Ingestion Server documentation site. --- ingestion_server/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 ingestion_server/README.md diff --git a/ingestion_server/README.md b/ingestion_server/README.md new file mode 100644 index 00000000000..99c808ca0fa --- /dev/null +++ b/ingestion_server/README.md @@ -0,0 +1,3 @@ +# Ingestion Server + +This service is documented at [docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html). From 6c20342f0fa82d11afc5ca1fd9568c312c0b4656 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 14:13:31 +0300 Subject: [PATCH 04/13] Create README.md Shim README file added to the frontend subfolder that point to the documentation site. --- frontend/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 frontend/README.md diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 00000000000..3545c8c95f2 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,3 @@ +# Frontend Service + +This service is documented at [docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html). From 7808b0f0c771010248a95017d8a7352ee71e2ace Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:08:16 +0300 Subject: [PATCH 05/13] Update README.md --- catalog/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/catalog/README.md b/catalog/README.md index 22bd6842114..4dce41b5a31 100644 --- a/catalog/README.md +++ b/catalog/README.md @@ -1,3 +1,3 @@ -# Catalog Service +# Airflow Catalog This service is documented at [docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html). From 1fa8fcf87e4c1ebda7b0479777df641ae26bbdd2 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:09:21 +0300 Subject: [PATCH 06/13] Update README.md --- api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/README.md b/api/README.md index aaa3cd12658..7ad9b4eaef7 100644 --- a/api/README.md +++ b/api/README.md @@ -1,3 +1,3 @@ -# API Service +# Django API This service is documented at [docs.openverse.org/api](https://docs.openverse.org/api/index.html). From a68ec7bb8448e3df98b45f92aa77078eff0516bc Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:10:29 +0300 Subject: [PATCH 07/13] Update README.md --- frontend/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/README.md b/frontend/README.md index 3545c8c95f2..40bbf74504f 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,3 +1,3 @@ -# Frontend Service +# Nuxt frontend This service is documented at [docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html). From 7c4756680ab30d889de523e09234c047d0ee8d76 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:11:20 +0300 Subject: [PATCH 08/13] Update README.md --- ingestion_server/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ingestion_server/README.md b/ingestion_server/README.md index 99c808ca0fa..1d2b4f5bc4c 100644 --- a/ingestion_server/README.md +++ b/ingestion_server/README.md @@ -1,3 +1,3 @@ -# Ingestion Server +# Ingestion server This service is documented at [docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html). From ad868b6f51cb01adb82ddfbd40877a06c779ffe6 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:19:23 +0300 Subject: [PATCH 09/13] Create README.md Add a shim README that direct to the documentation site --- documentation/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 documentation/README.md diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 00000000000..52c4828998d --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,3 @@ +# Documentation + +This service is documented at [docs.openverse.org/documentation](https://docs.openverse.org/meta/documentation/index.html). From ee1211fcc0095e686dbc66c2dc40459daf028440 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:23:37 +0300 Subject: [PATCH 10/13] Create README.md Add shim README file that link to the proper service documentation site --- automations/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 automations/README.md diff --git a/automations/README.md b/automations/README.md new file mode 100644 index 00000000000..35fcf6301ca --- /dev/null +++ b/automations/README.md @@ -0,0 +1,3 @@ +# Automations + +This service is documented at [docs.openverse.org/automations](https://docs.openverse.org/automations/index.html). From c461cffb9eb6854a6f9d3605a98b8f8cb36f516f Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:30:27 +0300 Subject: [PATCH 11/13] Create README.md --- packages/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 packages/README.md diff --git a/packages/README.md b/packages/README.md new file mode 100644 index 00000000000..8fcadb55735 --- /dev/null +++ b/packages/README.md @@ -0,0 +1,5 @@ +# Node.js packages + +This service is documented at [docs.openverse.org/packages](https://docs.openverse.org/packages/index.html). + + From eb05f22ac4ebad421024b0d2050c05d1911292b4 Mon Sep 17 00:00:00 2001 From: Bashir Sani <82951300+AlajeBash@users.noreply.github.com> Date: Thu, 19 Oct 2023 18:32:46 +0300 Subject: [PATCH 12/13] Update README.md --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 43f776260ab..ac125cb0c80 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -1,3 +1,3 @@ # `@openverse/eslint-plugin` -Refer to for documentation. +This service is documented at [docs.openverse.org/packages/eslint_plugin](https://docs.openverse.org/packages/eslint_plugin). From 4f26209595ce2d9754c26b919823ec81fd6fd298 Mon Sep 17 00:00:00 2001 From: Olga Bulat Date: Thu, 19 Oct 2023 20:24:25 +0300 Subject: [PATCH 13/13] Update --- api/README.md | 3 ++- automations/README.md | 3 ++- catalog/README.md | 3 ++- documentation/README.md | 3 ++- frontend/README.md | 3 ++- ingestion_server/README.md | 3 ++- packages/README.md | 5 ++--- packages/eslint-plugin/README.md | 3 ++- 8 files changed, 16 insertions(+), 10 deletions(-) diff --git a/api/README.md b/api/README.md index 7ad9b4eaef7..bd2e0272ff1 100644 --- a/api/README.md +++ b/api/README.md @@ -1,3 +1,4 @@ # Django API -This service is documented at [docs.openverse.org/api](https://docs.openverse.org/api/index.html). +This service is documented at +[docs.openverse.org/api](https://docs.openverse.org/api/index.html). diff --git a/automations/README.md b/automations/README.md index 35fcf6301ca..f21459be009 100644 --- a/automations/README.md +++ b/automations/README.md @@ -1,3 +1,4 @@ # Automations -This service is documented at [docs.openverse.org/automations](https://docs.openverse.org/automations/index.html). +This service is documented at +[docs.openverse.org/automations](https://docs.openverse.org/automations/index.html). diff --git a/catalog/README.md b/catalog/README.md index 4dce41b5a31..813b4262d37 100644 --- a/catalog/README.md +++ b/catalog/README.md @@ -1,3 +1,4 @@ # Airflow Catalog -This service is documented at [docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html). +This service is documented at +[docs.openverse.org/catalog](https://docs.openverse.org/catalog/index.html). diff --git a/documentation/README.md b/documentation/README.md index 52c4828998d..7701725e41d 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,3 +1,4 @@ # Documentation -This service is documented at [docs.openverse.org/documentation](https://docs.openverse.org/meta/documentation/index.html). +This service is documented at +[docs.openverse.org/documentation](https://docs.openverse.org/meta/documentation/index.html). diff --git a/frontend/README.md b/frontend/README.md index 40bbf74504f..d5b9ba46a3e 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,3 +1,4 @@ # Nuxt frontend -This service is documented at [docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html). +This service is documented at +[docs.openverse.org/frontend](https://docs.openverse.org/frontend/index.html). diff --git a/ingestion_server/README.md b/ingestion_server/README.md index 1d2b4f5bc4c..06ffcd8dd34 100644 --- a/ingestion_server/README.md +++ b/ingestion_server/README.md @@ -1,3 +1,4 @@ # Ingestion server -This service is documented at [docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html). +This service is documented at +[docs.openverse.org/ingestion_server](https://docs.openverse.org/ingestion_server/index.html). diff --git a/packages/README.md b/packages/README.md index 8fcadb55735..a5188c08043 100644 --- a/packages/README.md +++ b/packages/README.md @@ -1,5 +1,4 @@ # Node.js packages -This service is documented at [docs.openverse.org/packages](https://docs.openverse.org/packages/index.html). - - +This service is documented at +[docs.openverse.org/packages](https://docs.openverse.org/packages/index.html). diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index ac125cb0c80..fd4f61c6c5d 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -1,3 +1,4 @@ # `@openverse/eslint-plugin` -This service is documented at [docs.openverse.org/packages/eslint_plugin](https://docs.openverse.org/packages/eslint_plugin). +This service is documented at +[docs.openverse.org/packages/eslint_plugin](https://docs.openverse.org/packages/eslint_plugin).