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
Merged

Conversation

AlajeBash
Copy link
Contributor

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.

AlajeBash and others added 13 commits October 19, 2023 20:20
Shim README files added to the catalog sub folder that point to the documentation site.
Shim README files added to the api subfolders that point to the documentation site.
README file Updated to the `Shim README` file that point to Ingestion Server  documentation site.
Shim README file added to the frontend subfolder that point to the documentation site.
Add a shim README that direct to the documentation site
Add shim README file that link to the proper service documentation site
@AlajeBash AlajeBash requested a review from a team as a code owner October 19, 2023 18:47
@AlajeBash AlajeBash requested review from krysal and dhruvkb October 19, 2023 18:47
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels Oct 19, 2023
@dhruvkb dhruvkb changed the title Updated Add shim README.md files in project directories Oct 20, 2023
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work, @AlajeBash! The repository will be more welcoming and easy to understand for contributors.
Thank you for your contribution 🎉

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @AlajeBash, this is great!

@dhruvkb dhruvkb merged commit 364d07a into WordPress:main Oct 20, 2023
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add shim READMEs to service subfolders pointing to the documentation site
4 participants