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 page to go with each of the templates #152

Open
4 of 7 tasks
geekygirldawn opened this issue Jan 28, 2022 · 8 comments
Open
4 of 7 tasks

Documentation page to go with each of the templates #152

geekygirldawn opened this issue Jan 28, 2022 · 8 comments

Comments

@geekygirldawn
Copy link
Member

geekygirldawn commented Jan 28, 2022

We need to create a documentation page on the maintainer website for each of the templates in the CNCF project-template repo. The documentation would go into detail about how to use the templates along with guidance for how to customize each template based on the needs of each individual project.

Here's a checklist to help us track this:

  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTOR_LADDER.md
  • GOVERNANCE-elections.md
  • GOVERNANCE-maintainer.md
  • GOVERNANCE-subprojects.md
  • README_TEMPLATE.md

Note that for some of these templates, there are new versions in a PR in the drafts branch of the repo.

@geekygirldawn
Copy link
Member Author

I'm happy to start on the governance templates, but if someone from contrib growth could pick up the contributor templates, that would be rad.

@carolynvs
Copy link
Contributor

@geekygirldawn #131 shows what Karen and I have been working on for the corresponding web page for each template.

@geekygirldawn
Copy link
Member Author

Here's an example.

@Arijit1000
Copy link

@geekygirldawn I'm happy to start working on the CONTRIBUTING.md file. It will give an overview of the Contributing Guide on the maintainer website.

@aliok
Copy link
Member

aliok commented Feb 6, 2024

@geekygirldawn I would consider this done as I see all the mentioned files in https://github.com/cncf/project-template.

Are we good to close it?

UPDATE: my bad... This is about creating the documentation for the templates.

@geekygirldawn
Copy link
Member Author

I can't find the how-to to go with the contributor ladder template or the readme template?

We don't need one for CoC, since we just ask people to point to the CNCF one.

@geekygirldawn
Copy link
Member Author

We do need a short CoC how to.

@geekygirldawn geekygirldawn removed their assignment May 2, 2024
@geekygirldawn
Copy link
Member Author

#534 goes along with the contributor ladder how to

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 📋 Backlog
Development

No branches or pull requests

4 participants