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

Glossary #140

Closed
carolynvs opened this issue Nov 11, 2021 · 9 comments · Fixed by #395
Closed

Glossary #140

carolynvs opened this issue Nov 11, 2021 · 9 comments · Fixed by #395

Comments

@carolynvs
Copy link
Contributor

carolynvs commented Nov 11, 2021

Add a glossary of terms (not technical) related to how the CNCF and its projects are organized that we use in the CNCF and on contribute.cncf.io.

It should be a new page located at contribute.cncf.io/glossary. If you need help with the Hugo templates/page design, etc, please reach out and we can get assistance. When in doubt, just focus on creating the appropriate text and a page for it, and we can have the CNCF help with the web design.

If you are looking for inspiration a great example to copy would be glossary.cncf.io

@carolynvs
Copy link
Contributor Author

carolynvs commented Jan 24, 2023

Here are some common terms used on the site that we can use to kick off the glossary. I am providing some guidance on the definition but we really need someone to look for existing definitions from other sources (such as cncf repositories or the cncf glossary https://glossary.cncf.io/) and make sure we are linking whenever possible to canonical documentation for the term.

  • CNCF - Cloud Native compute foundation (add link to cncf site)
  • TAG - Technical Advisory Group is a group appointed by the CNCF Technical Oversight Committee (TOC) to assist with a specific subdomain such as security or networking. You can find a list of tags at https://github.com/cncf/toc/blob/main/tags/README.md.
  • TOC - Technical Oversight Committee (add link to github.com/cncf/toc). The CNCF Technical Oversight Committee is the technical governing body of the CNCF Foundation. It admits and oversees all projects in the CNCF Foundation and has a mandate to facilitate driving neutral consensus for:
    • defining and maintaining the technical vision for the Cloud Native Computing Foundation,
    • approving new projects within the scope for CNCF set by the Governing Board (GB), and create a conceptual architecture for the projects, aligning projects, removing or archiving projects,
    • accepting feedback from end user committee and map to projects,
    • aligning interfaces to components under management (code reference implementations before standardizing), and defining common practices to be implemented across CNCF projects, if any.
  • SIG - Special Interest Group, commonly used by the Kubernetes project to organize contributors around specific topics for further development. Link to https://github.com/kubernetes-sigs
  • Working Group - Within a SIG or TAG, we may organize a smaller group of people who are working on a specific sub-area within the group.
  • Charter
  • Governance
  • Maintainer (this varies between projects but could generally be defined as people with commit access to the project repository)
  • Contributor (again this varies but should be inclusive and provide for both code and non-code contributions such as project management, content, documentation, user support and more.

The terms we put in our glossary should not be technical terms and should be related to the organization of CNCF and its projects.

@carolynvs
Copy link
Contributor Author

I can't official assign @dankingkong to the issue but he is working on it. ✅

@dankingkong
Copy link
Contributor

@carolynvs, I have done a PR for the glossary. Please let me know if this is what you were wanting.
Cheers.
Dan

@carolynvs
Copy link
Contributor Author

It's looking really good but I haven't had time yet to review more closely. I have asked another person on the TAG to give it a look but we may not get to it for another day or two.

@dankingkong
Copy link
Contributor

dankingkong commented Feb 6, 2023 via email

@dankingkong
Copy link
Contributor

dankingkong commented Feb 6, 2023 via email

@carolynvs
Copy link
Contributor Author

Every project is run differently depending on its size, complexity and available volunteers. Projects with maintainers and contributors who are paid to work on it, such as kubernetes, are more likely to have people dedicated to PM, while others may not have sufficient people/time to do that (like this TAG). 😁

A better place to ask off-topic questions by the way would be our Slack channel, mailing list or the discussions forum on this repo. Otherwise it derails the original issue and is hard for people to track and find later.

@aliok
Copy link
Member

aliok commented May 9, 2023

I created #395 for the website setup. If people agree with that setup, somebody can focus on writing the missing text and we would be good to go.

@aliok
Copy link
Member

aliok commented May 12, 2023

There's a demand for this kind of less-technical glossary :)

Slack message from @TheFoxAtWork (link):

Do you all happen to have some definitions around contributor, committer, maintainer, commit bit, owner, etc. wrt open source projects? We seem to use these terms a lot in the TOC repo and elsewhere but i can’t actually find where we explain what they are and what they mean. This information is useful for individuals not familiar with these concepts in open source or more specifically how they are used and leveraged in CNCF. See this comment on a TOC PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Contributor Strategy Planning
  
Needs an Owner / Backlog
Development

Successfully merging a pull request may close this issue.

5 participants