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

Create and populate /docs folder for repo-default files #14

Open
joewxboy opened this issue Apr 22, 2022 · 3 comments
Open

Create and populate /docs folder for repo-default files #14

joewxboy opened this issue Apr 22, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@joewxboy
Copy link
Member

Project-wide issue & PR templates, CONTRIBUTOR/SECURITY/SUPPORT (community health) files, and possibly workflows/GHA can all have default versions created in this .github repository. It will also allow individual repositories to override the default if they wish by creating their own. This should make discoverability and maintainence much easier going forward.

Therefore, let's:

  • Create a /docs folder
  • copy/move the issue, PR, and _config.yml files from open-horizon.github.io repo to this one
  • Create a CONTRIBUTORS.md file with "active" and "emeritus" sections with the below format

| Name | GitHub | email
|------|--------|------|----------------------
| Joe Pearson | joewxboy | [email protected]

@joewxboy joewxboy added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Apr 22, 2022
@Sukriti-sood
Copy link
Member

Sukriti-sood commented Apr 27, 2022

@joewxboy This is very nice feature

@johnwalicki
Copy link
Member

I don't understand how this Issue will work. Will ask @joewxboy to explain.

@joewxboy
Copy link
Member Author

joewxboy commented May 3, 2022

@johnwalicki a new(ish) technique is now available to us that solves three separate problems:

  1. How do we create links in the right-hand column that give support resources to issue developers?
    The answer is Community Health Files stored in ".github" repo in "/docs" folder. Support is stored in well-known filename SUPPORT.md and GitHub will magically import and display in right-hand column on certain pages.
  2. How do we create default or standard issue and PR templates for all repos in a github project, and also allow each repo to override as needed?
    The answer is to move the templates and related files to the ".github" repo, same folders.
  3. Where do we create project-wide files like CONTRIBUTORS.md that apply to all repos?
    We are allowed to place in ".github" root folder or "/docs" folder. Putting it in /docs reduces the clutter, but hides the files somewhat. We can compensate by providing hyperlinks in the root folder README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants