cncf
[SANDBOX PROJECT ONBOARDING] Ratify
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
- [x] The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
- [x] The project proposal process and requirements.
- [x] The services available for your project at the CNCF.
- [x] The CNCF IP Policy.
- [x] The trademark guidelines.
- [x] The license allowlist.
- [x] The online program guidelines.
- [ ] Optional: Book time with CNCF staff for any onboarding questions.
Contribute and transfer
- [x] 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.
- [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add
thelinuxfoundationas an organization owner to ensure neutral hosting of your project. - [x] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
- [x] Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [x] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
- [x] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement.
- [x] Submit a pull request with your artwork.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document
- [x] Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
- [x] Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's
READMEon GitHub. - [x] 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
READMEfile). - [x] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
- [x] Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
- [x] Start working on written, open governance.
- [x] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks
- [x] Add the project to DevStats.
- [x] 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.
- [x] 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.
Hi team,
I am a maintainer from Ratify community. We are making progress on these two items. Can you please help mark them as completed? Thanks
- [ ] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help. (Ratify CNCF channel https://cloud-native.slack.com/archives/C03T3PEKVA9)
- [ ] Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions. (See https://github.com/cncf/landscape/pull/4077)
@Cmierly have this project been set to active in PCC. I can not find them. (They have a service desk ticket open to get PCC meetings set up)
@riaankleinhans Thanks for following up here.
@Cmierly Would you mind approving Ratify to be set to active in PCC? We need CNCF to help create a Zoom account to run community meetings. Thanks
@FeynmanZhou we have a slightly new process for handling the trademark transfer process. I'll share instructions shortly. That task now needs to happen before we can activate you in PCC (which in turn is needed for Zoom and Insights).
@krook Thanks. We didn't register trademark for Ratify. Should we rely on CNCF to register it directly?
@FeynmanZhou Hi! We will have more information for you on what to do if you don't have a registered trademark once we get this new process rolling
Thank you!
@Cmierly Thank you. Is it possible to help us activate the Ratify account in PCC first? In this way, CNCF could register a Zoom account for Ratify.
@FeynmanZhou Unfortunately, not at this time. I'm very sorry! We will be getting this new process up and running shortly
Sorry for the delay @FeynmanZhou. The new 2025 "Project Contribution Agreement" is now available.
This replaces the trademark agreements mentioned in the original checklist.
I'll be sending an email to the contacts listed in the Sandbox application issue to handle next steps.
Please review the instructions in the email, fill out the Google Doc, and then we can it them completed via Docusign.
Once done, that will unblock us from continuing the rest of these Sandbox onboarding tasks.
We can address any questions about the Agreement over email.
@krook Thank you. Email received. I am now following the instructions to fill out the new Project Contribution Agreement.
@FeynmanZhou as we handle the Contribution Agreement over email, are there any other tasks in the list we can check off in the meantime? Some of them are just simple things like reviewing a few Markdown files.
Hi @krook ,
Brendan Burns has signed the CNCF's Project Contribution Agreement for Ratify yesterday on behalf of Microsoft.
Would you mind helping us activate the Ratify account in PCC and register a Zoom account for Ratify?
Thanks!
Would you mind helping us activate the Ratify account in PCC and register a Zoom account for Ratify?
Yes indeed. Sent a follow up by email now that it's active.
@FeynmanZhou are there any other tasks we can check off that have been completed (like reviewing documents etc)?
Hi @krook , would you mind marking this item "Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request." as completed. See https://github.com/cncf/foundation/pull/935 Also, for those docs under Review and understand, shall we check them off as we already reviewed?
Thanks @FeynmanZhou I've marked those all complete.
In the newest onboarding checklists we've moved this one to be a maintainer rather than staff task since this is a public channel. Ratify maintainers can add themselves to it:
- [ ] Invite developers to the #maintainers-circle Slack channel.
Hi @krook ,
We can mark these two as completed since the Linux Foundation team worked with us to get the domain ratify.dev transferred to CNCF.
For second item listed below, we didn't set up website analytics before so no action from the Ratify maintainers. As CNCF now owns the domain, CNCF should be able to set up the website analytics.
- Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
- Transfer website analytics to [email protected]. CNCF staff can help.
Excellent, thanks for the update @FeynmanZhou.
So the two that you can complete are:
- [x] Invite developers to the #maintainers-circle Slack channel. Since this is now a public channel, you can add yourselves there.
- [ ] Optional: Book time with CNCF staff for any onboarding questions. As it says, it's optional so let me know if I can check this off.
CNCF staff will handle these:
- [ ] Add a license scanning tool, like FOSSA or Snyk. FYI @RobertKielty
- [x] 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.
- [ ] Send a welcome email to confirm maintainer list access.
@krook Thanks for your quick response.
I will add Ratify maintainers to to the #maintainers-circle Slack channel today.
We may want to book a time with CNCF staff to discuss another idea. I just sent an email to consult you about that idea. Let's keep aynsc discussion now.
I can set up the team today on FOSSA or Snyk to comply with 3rd Party License Policy.
@FeynmanZhou do you have a preference for which service you would like to use?
Hi @RobertKielty, just to follow up, is the license scanning tool setup ready? Thanks
Hi @FeynmanZhou thank you for your patience.
I have set up a Ratify organization on the CNCF Snyk Tenancy and I invited all of the registered maintainers to join that org.
The final step is for you to accept the invitation and then add all of your GitHub repos as projects in your Snyk Ratify Organization.
@RobertKielty I received the invitation from both Snyk and FOSSA. Should I only accept Snyk if they have the similar functions.