Welcome to CNCF Project Onboarding

ref: #523

This is an issue created to help onboard your project into the CNCF after the TOC has voted to accept your project.

We would like your project to complete onboarding within one month of acceptance.

Please track your progress by using "Quote reply" to create your own copy of this checklist in the issue, so that you can update the status as you finish items.

REQUIRED BEFORE PROCEEDING WITH ONBOARDING

A "Project Contribution Agreement" must be completed and any existing trademarks MUST be transferred to the Linux Foundation BEFORE the CNCF staff onboarding tasks can be completed. Other tasks can be done by projects themselves in the meantime.

• Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license. Licenses for dependencies are covered separately below.
• Review and understand the CNCF Third Party License Policy. This policy governs the licenses used by third party libraries in your project. CNCF FOSSA or CNCF Snyk are configured to check that projects are in compliance with this policy. Let us know which service you would prefer to use.
• Review and understand the LF trademark guidelines. Let the TOC know if you plan to change your project name.
• Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement. CNCF staff will send this document to the contact emails listed in the Sandbox application.

Review and understand other documents

• The Technical Leadership Principles that outline the expected behavior for any maintainer in a leadership role.
• The project proposal process and requirements.
• The services available for your project at the CNCF.
• The online program guidelines.
• The telemetry data collection and usage policy.
• Optional: Book time with CNCF staff to understand CNCF resources available to you, to work through onboarding tasks together, or ask other questions.

Contribute and transfer other materials

• Move your project to its own separate neutral GitHub organization. This will make it transferable to the CNCF's GitHub Enterprise account. If it's already in another GHE account, you will need to remove it from that first.
• Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help. This allows project communities to be more discoverable, allows the CNCF to enforce its Code of Conduct, and enables unlimited message retention.
• Join the #maintainers-circle Slack channel to find and share knowledge with other project teams.
• Transfer your domain(s) to the CNCF if they exist. The "LF Contact" is [email protected]. The "Project Selection" is CNCF.
• Submit a pull request with your artwork if it exists. If you don't have artwork, CNCF can help design some.
• Transfer website analytics if they exist. Make [email protected] an admin of your existing Google Analytics org account so that we can move it to a CNCF-managed account.

Update and document project details

• Create or ensure your .project repo is up to date with maintainer information.
• Ensure each maintainer has an up-to-date LFX Individual Dashboard profile that includes an active email address in order to get access to the mailing list and Service Desk.
• Ensure the DCO app is enabled for all GitHub repositories of the project. You may also choose to use a CLA in addition to the DCO.
• Ensure that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced in the project's README.md on GitHub.
• Ensure the LF footer is on your website and guidelines are followed (if your project doesn't have a dedicated website, please adopt those guidelines for the README.md file).
• Start working on written, open governance and consider adding this to a GOVERNANCE.md file at the root of your repo.
• Start working on a security policy and consider adding this to a SECURITY.md file at the root of your repo.
• Start working on an OpenSSF Best Practices Badge.
• Import all project repos into your chosen license scanning service (CNCF FOSSA or CNCF Snyk).

CNCF staff tasks to support the project

• Add the project to DevStats.
• Add the project to CLOmonitor.
• Add the project to LFX Insights.
• Activate the project in the LFX Project Control Center.
• Add the project to the Cloud Native Landscape after PCC activation, including the lfx_slug in the landscape configuration file.
• Add the maintainers team to a license scanner service, either, CNCF FOSSA or CNCF Snyk.
• Create groups.io project maintainer list in PCC.
• Create project in CNCF Service desk
• Run Onboard Project workflow
  • Run Service desk and group.io workflow
• Add project's groups.io maintainer list to [email protected]
• Send a welcome email to confirm maintainer list access.

Related Issue: This onboarding issue was automatically created after the community vote was completed in issue #523.