Update the Shim README title to be the same as the title of the linked docs page and adding a shim README.md file that redirect to the appropriate service documentation site

[AlajeBash]

Fixes

Fixes #3205 by @AetherUnbound

Description

I add shim README files to the required service subfolders that point to the documentation site, by can create a simple README.md file in each of the subfolder of the services with the appropriate links.

Airflow Catalog

  # Airflow Catalog
   This service is documented at [docs.openverse.org/catalog]
   (https://docs.openverse.org/catalog/index.html).

Django API

  # Django API
   This service is documented at [docs.openverse.org/api] 
   (https://docs.openverse.org/api/index.html).

Ingestion server

  # Ingestion Server
   This service is documented at [docs.openverse.org/ingestion_server] 
   (https://docs.openverse.org/ingestion_server/index.html).

Nuxt frontend

  # Nuxt frontend
   This service is documented at [docs.openverse.org/frontend] 
   (https://docs.openverse.org/frontend/index.html).

documentation

  # Documentation
   This service is documented at [docs.openverse.org/documentation] 
   (https://docs.openverse.org/meta/documentation/index.html).

Automations

  # Automations
   This service is documented at [docs.openverse.org/automations] 
   (https://docs.openverse.org/automations/index.html).

Node.js packages

  # Node.js packages
   This service is documented at [docs.openverse.org/packages] 
   (https://docs.openverse.org/packages/index.html).

@openverse/eslint-plugin

  # @openverse/eslint-plugin
   This service is documented at [docs.openverse.org/packages/eslint_plugin] 
   (https://docs.openverse.org/packages/eslint_plugin/index.html).

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[obulat]

I re-based this PR onto the wordpress/main branch for you. It should be fine now, and I'll approve as soon as the CI passes. Thank you for your contribution, @AlajeBash !
For the future, never open a PR from your main branch: it is really difficult to update your fork after that because the main branches diverge. I've done so, and I know how difficult it is :)

[dhruvkb]

You will have to add exclude_patterns to the Sphinx conf so that the documentation/README.md does not raise errors about not being included in the toctree.