CNCF Onboarding Checklist

[adambkaplan]

Copied from cncf/sandbox#131. Dropped items that CNCF staff is responsible for.

Welcome to CNCF Project Onboarding!

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

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 an issue, so that you can update the status as you finish items.

Review and understand

• The project proposal process and requirements.
• The services available for your project at the CNCF.
• The CNCF IP Policy.
• The trademark guidelines.
• The license allowlist.
• The online program guidelines.
• Optional: Book time with CNCF staff for any onboarding questions.

Contribute and transfer

• 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 a 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.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions. Update on Project Shipwright cncf/landscape#4035
• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
• Transfer any trademark and logo assets to the Linux Foundation.
• Submit a pull request with your artwork. Add Shipwright art work cncf/artwork#507
• Transfer website analytics to [email protected]. CNCF staff can help.

Update and document

• Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
• Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub. Onboard cncf .github#5
• Ensure 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 file). Move into hugo modules and adapt existing code and docs website#131
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request. ADD MAINTAINERS file #242 and Add Project Shipwright maintainers cncf/foundation#860
• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected]. Email sent.
• Start working on written, open governance. Define project written Governance #243
• Start on an OpenSSF Best Practices Badge.

[qu1queee]

Some updates:

• Website PR for including CNCF trademark,etc Update website website#130
• PR for updating our entry in the CNCF landscape Update on Project Shipwright cncf/landscape#4035
• DOC is enabled now in all repositories of the Shipwright github org
• Meeting with CNCF staff is already scheduled

[adambkaplan]

[ ] Transfer any trademark and logo assets to the Linux Foundation.

We should check with Michelle Martineau or Todd Moore - I think this already "done" and no actual paperwork needs to be filled out.

[adambkaplan]

Per Red Hat OSPO - the shipwright.io domain registration was already transferred to the Linux Foundation when the project was donated to the CDF. Domain transfer to the CNCF will either be a no-op or a matter of updating records on the LF side of things.