-
Notifications
You must be signed in to change notification settings - Fork 214
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
Conversation
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
There was a problem hiding this 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 🎉
There was a problem hiding this 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!
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
Django API
Ingestion server
Nuxt frontend
documentation
Automations
Node.js packages
@openverse/eslint-plugin
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin