sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] bootc
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/310
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 an 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 CNCF staff onboarding tasks can be completed.
- [ ] Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
- [ ] Review and understand the LF trademark guidelines.
- [ ] 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
- [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 dependency license allowlist.
- [x] The online program guidelines.
- [x] The telemetry data collection and usage policy.
- [x] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer other materials
- [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. - [ ] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
- [ ] Join the #maintainers-circle Slack channel.
- [ ] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
- [ ] Submit a pull request with your artwork.
- [ ] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document project details
- [x] 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.mdon 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.mdfile). The project-specific footer text you should use will be provided in the Contribution Agreement instructions. - [ ] 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 and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [ ] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks to support the project
- [x] Add the project to DevStats.
- [x] Add the project to CLOmonitor.
- [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.
- [x] Add the project to LFX Project Control Center.
- [ ] Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [ ] Add a license scanning tool, like FOSSA or Snyk.
- [ ] Send a welcome email to confirm maintainer list access.
I am the owner of the bootc.io domain, currently used for redirecting bootc.io/ and www.bootc.io/ to GitHub Pages.
Happy to transfer ownership to the CNCF whenever you all are ready - just let me know the details! Looking at the Jira request, I think I only need to know the "Community Stakeholder email" before I can initiate the transfer.
I'm reachable through the Fedora Matrix at @rsturla:fedora.im.
Note: I'm not a member of RedHat or the bootc team, just a helpful community member :)
Welcome to the CNCF Sandbox @marrusl and the bootc team!
CNCF staff is working on the first step, which is to create and share the Contribution Agreement with you shortly.
I'll send an email to the contacts listed on the Sandbox application. The Contribution Agreement can be signed by the contributing organization listed there, or a group of individuals.
Welcome again to the CNCF Sandbox! We're creating the Contribution Agreement document for you now and should have it to you shortly.
In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
I am the owner of the bootc.io domain, currently used for redirecting bootc.io/ and www.bootc.io/ to GitHub Pages.
Happy to transfer ownership to the CNCF whenever you all are ready - just let me know the details!
Thanks @p5! Once the CA is signed, we can activate the project in the LF records and then work on transferring the domain.
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.
Silly mechanical thing...using "quote reply" seems to corrupt the Markdown formatting, mashing together the lists into paragraphs (in addition to quoting everything). I am not seeing a way via the Github UI to get access to the raw markdown, though I could probably figure it out maybe by dropping to the API. (OK I looked, apparently it's not possible?)
This seems like a surprising papercut on Github's side. But anyways we can probably work around it - I presume the raw markdown input for this comes from a template somewhere, can you point to that template?
And we should probably update the recommendations to suggest pointing to that template?
(Followup, a quick search took me to https://github.com/cncf/sandbox/blob/a4b573c7450d532385ec4d488adce87c2067522f/.github/ISSUE_TEMPLATE/project-onboarding.md )
@cgwalters yeah it seems like something changed with how GitHub formats checklists now. And as of today in Chrome the original checklist is oddly aligned as well.
Here's the raw issue template Markdown you can use.
Ha. Looks like our comments were posted at the same time. Glad you found it. The raw is probably the easiest to copy from.
The followup checklist for the work on this is now at https://github.com/containers/bootc/discussions/897#discussioncomment-11904738 - am I doing this right? The template says "create your own copy of this checklist in an issue" but did it mean an issue on this repo? Or is using the bootc one OK?
Thanks @cgwalters creating a copy here as a comment or in your own repo will work. I like what you did so let's go with that and we'll sync it back here.
Oops sorry meant to comment here!
Sorry for the delay but the Github transfer is now complete! https://github.com/bootc-dev/bootc/discussions/897#discussioncomment-12430782
How do we proceed with the onboarding?
Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:
- Add
thelinuxfoundationas an an organization owner, if it's not already one. - Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
We want to host the bootc meetings in a public zoom call. Tried creating an account in Service desk with my rh email to request zoom access and I get: We couldn't give you access. Use another email and try again.. I believe one of team members sent our emails your way, not sure if there is anything else needed from our side.
Hi, I'm trying to figure out the current state of things here. I heard we may be blocked on a legal issue, is that true? Or am I wrong about that and we can just run through the rest of these checklist items?
Hi @cgwalters, the Contribution Agreement process is still ongoing but that doesn't block progress on the other tasks here. Are there things you've completed on your side that we can check off?
- Add
thelinuxfoundationas an an organization owner, if it's not already one.- Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
This has now been done by the CNCF staff
Hi @cgwalters, the Contribution Agreement process is still ongoing but that doesn't block progress on the other tasks here. Are there things you've completed on your side that we can check off?
@cgwalters while we await the CA to be reviewed, are there other tasks here that you've completed that we can check off?
@cgwalters do the team have a preference to use FOSSA or Snyk for license scanning? Let me know and I will set either up for you.
I don't have enough familiarity to say, but I guess I'd say FOSSA as that was chosen in https://github.com/cncf/sandbox/issues/338#issuecomment-2808933762
I've sent out CNCF FOSSA invitations to @ckyrouac @jeckersb @henrywang @gursewak1997 @jmarrero
Please accept the invitations and let me know when you have. I must then add you as Team Admins to the bootc team on our FOSSA.
After I've added you to the bootc team on CNCF FOSSA, you can import the bootc code repos into the team.
@cgwalters as you already have an account on FOSSA, I couldn't invite you to join CNCF FOSSA, we can log a support call with FOSSA to migrate your account over to CNCF FOSSA. You will loose access to your existing account. Usually fine if it is a personal account that you set up to check out FOSSA. If you are using it for other work and cannot lose the account let me know.
@RobertKielty Thanks. Is that an email? What's the title of it? I don't see it.
[email protected] is the support email address.
You can cc me/reference the comment above.
I sent you a direct message on cloud native slack.
I can't find an email from [email protected] either. When you say "Accept the invitations" - is that invitation an email? What's the title and sender?
The Landscape entry is here - https://github.com/cncf/landscape/pull/4362
@cgwalters are there any other tasks we can mark complete while we await the Contribution Agreement review?
@RobertKielty for the FOSSA question.