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.

Sign up for GitHub

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

Naming convention guidance for new projects #1514

Merged
merged 1 commit into from
Jan 14, 2025
+4 −0
Merged

Naming convention guidance for new projects #1514

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions process/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Projects may enter the CNCF either by applying as a sandbox project or applying

Evaluting projects against the criteria does take some time and the TOC has recently modified the Due Diligence process to reduce duplication of work, streamline handoffs, and provide better transparency to the project and its adopters about its conformance and implementation of the criteria.

## Naming conventions for projects

All CNCF projects are subject to the [Trademark Usage Policies](https://www.linuxfoundation.org/legal/trademark-usage) set by Linux Foundation. Specifically, new or incoming projects should avoid use existing trademarks in their proposed project names. In addition, if they are intending to use a popular prefix/suffix of an existing project (like "kube" or "k8s"), then they should consult the leadership group of the respective project to seek their approval and document the consensus reached. Existing projects are encouraged to document their naming guidelines to make this process smooth as well to avoid lengthy deliberation process for new project names.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK, k8s is a tademark of kubernetes so should be avoided.

I think we should ask new/incoming projects to follow existing project's naming guideline and not use the reserved prefix/suffix based on the guideline if the project has a naming guideline. Consult the project leadership could be perceived as subjective as some project could be mostly owned by a single company.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/existing trademarks/[existing rademarks](see https://www.linuxfoundation.org/legal/trademarks)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@linsun k8s and kube is not trademarked. We have to cover the cases where the naming doc is not yet created by the leadership (Steering, TC or equivalent), so we have to cover that as well. I fully expect k8s steering folks to draft something soon, we just have to work with other projects to do theirs.

We should not be trying to deal with single company here. there are other mechanisms in our arsenal to deal with that i think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, on the last TOC call of December we did confirm that "K8s®" is in the list of trademarks on https://www.linuxfoundation.org/legal/trademarks. The assumption was that it was not. "Kube" alone is not trademarked according to the list.

Copy link
Member Author

@dims dims Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krook ah thanks for confirming! my bad @krook @linsun

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consult the project leadership could be perceived as subjective as some project could be mostly owned by a single company.

We should not be trying to deal with single company here. there are other mechanisms in our arsenal to deal with that i think.

+1, IMHO single-company-owned projects is something that needs addressing regardless and shouldn't be in scope here.

(FWIW in this particular example, that's not the case, as we have maximum representation rules limiting to 2/7 of the committee ... I think those rules have worked well if only to at least limit perception of excessive individual company influence.)

@dims is there anywhere tracking that topic currently?

I fully expect k8s steering folks to draft something soon, we just have to work with other projects to do theirs.

Yes, people are still filtering back from holiday vacations but I expect a draft soon. We meet tomorrow.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cross link the PR from @BenTheElder https://github.com/kubernetes/community/pull/8238/files.

Okay with skipping single-company-owned projects.


### Project resources and guide posts

The TOC, with support from the [Technical Advisory Groups](/tags/README.md), have a wide variety of resources available to assist projects. Current and aspiring maintainers of cloud native projects can find a lot of information and templates on [contribute.cncf.io/maintainers](https://contribute.cncf.io/maintainers/). The TOC also maintains [project Guide Posts](../docs/project_guideposts.md) - a collection of guiding points that have assisted cloud native projects as they grow and mature in the ecosystem. These are not requirements for moving levels, those may be found in the respective application issue templates ([Incubation](../.github/ISSUE_TEMPLATE/template-incubation-application.md), [Graduation](../.github/ISSUE_TEMPLATE/template-graduation-application.md)). The [Guide Posts](../docs/project_guideposts.md) are a resources for projects to leverage that is beneficial in meeting or exceeding the criteria defined.
Expand Down