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

Documentation: Audit the contents of CONTRIBUTING.md #2118

Closed
ysuarez opened this issue Jun 1, 2022 · 1 comment
Closed

Documentation: Audit the contents of CONTRIBUTING.md #2118

ysuarez opened this issue Jun 1, 2022 · 1 comment
Assignees
Labels
Type: bug identifies a problem in the software with clear steps to reproduce

Comments

@ysuarez
Copy link
Contributor

ysuarez commented Jun 1, 2022

The contents of CONTRIBUTING.md are a bit redundant and out-of-date with some existing pages in the rest of the mkdocs official docs.

This file is also being displayed within the official docs at this path...
https://islandora.github.io/documentation/contributing/CONTRIBUTING/

It is normal that CONTRIBUTING.md exists in the root directory of the a repo, specially if it was a repo for storing code. Though this is a documentation repo nowadays. We may want to come up with a new way of using the CONTRIBUTING.md or eliminating it. For example, we may want to just put links to the relevant sections in the official docs, instead of maintaining content in two places.

@ysuarez ysuarez added the Type: bug identifies a problem in the software with clear steps to reproduce label Jun 1, 2022
@islandora-community
Copy link
Contributor

islandora-community commented Jun 15, 2022

A doc to discuss CONTRIBUTING.md in future Tech Calls and the upcoming Documentation Sprint.
This reflects revisions made by @inikolaidis to reference the new issue templates. Comments and feedback are appreciated! @Islandora/documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: bug identifies a problem in the software with clear steps to reproduce
Projects
None yet
Development

No branches or pull requests

3 participants