[SANDBOX PROJECT ONBOARDING] Shipwright

[Cmierly]

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 Technical Leadership Principles that outlines 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 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.
• 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.
• 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.
• 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).
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
• Start working on written, open governance.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks

• Add the project to DevStats.
• Add the project to CLOmonitor.
• Add the project to LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
• Add the project to LFX Project Control Center.
• Add a license scanning tool, like FOSSA or Snyk.
• Invite developers to the #maintainers-circle Slack channel.
• Send a welcome email to confirm maintainer list access.

[lukaszgryglicki]

DevStats instance ready.

[lukaszgryglicki]

Project added do Project Health and All Projects Health.

[qu1queee]

Hello all! I'm following on this issue on behalf of the Shipwright Community and I would provide a status update on where we are, in the following days.

[adambkaplan]

Regarding Slack - we have a pre-existing channel on Kubernetes slack - #shipwright

[cynthia-sg]

Project has been added to CLOMonitor

[qu1queee]

Hi folks, I'm providing you here an update on where we are, and what is currently missing. If we need help, we will add a new comment to this issue. We are tracking daily our updates in shipwright-io/community#240 .

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 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 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. DCO was enabled and an email sent to the developer mailing list.
• 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 shipwright-io/.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 shipwright-io/website#131
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request. ADD MAINTAINERS file shipwright-io/community#242 and Add Project Shipwright maintainers 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 shipwright-io/community#243
• Start on an OpenSSF Best Practices Badge. See https://www.bestpractices.dev/en/projects/5315

[adambkaplan]

[ ] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].

Domain registration (shipwright.io) was previously transferred to the Linux Foundation when the project was donated to the CDF. I'm not sure if anything needs to be done to mark this item "done" (maybe some record keeping on the CNCF/LF side of things?)

[krook]

[ ] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].

Domain registration (shipwright.io) was previously transferred to the Linux Foundation when the project was donated to the CDF. I'm not sure if anything needs to be done to mark this item "done" (maybe some record keeping on the CNCF/LF side of things?)

I just marked this as complete. I see the LF is the registrant for it.

[qu1queee]

Hello all,

We are almost completed with the on-boarding items, see our previous comment. There are only two open items on our side:

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

We are wondering if there is something to do here, as we are coming from the Continuous Delivery Foundation.

[ ] Transfer website analytics to [email protected]. CNCF staff can help.

We kindly ask for your help on this one.

[krook]

@RobertKielty can you please assist with FOSSA and/or Synk?

[RobertKielty]

Hi @qu1queee @SaschaSchwarze0 @adambkaplan

Can you please let me know what preference you have for license scanning services? I can setup you up on CNCF Service Instances for FOSSA or Snyk.

[qu1queee]

@RobertKielty we seem not to have one, could you give us a recommendation?

[adambkaplan]

@RobertKielty I'm personally more familiar with Snyk.