sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] Runme Notebooks
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/127
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.
- [x] 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.
- [x] Review and understand the LF trademark guidelines.
- [x] 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.
- [ ] 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.
Welcome to the CNCF Sandbox @admc and the Runme Notebooks 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.
- [x] 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.
- [x] Review and understand the LF trademark guidelines.
- [x] 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.
☑ Done
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.
- [ ] The telemetry data collection and usage policy.
- [x] Book time with CNCF staff to understand project benefits and event resources.
Still working through licenses and telemetry.
@mrbobbytables, as part of completing the dependency license allowlist, is it sufficient to report gaps, or is the requirement to be fully compliant to check off the item?
@mrbobbytables Similarly, for the telemetry data collection and usage policy, Runme uses Scarf.sh and aggregated usage metrics without any form of PII, and users have complete control over it (e.g., understand DO_NOT_TRACK=1). Do we need to complete a legal review to complete this item?
@krook, perhaps I should have pinged you about my questions ☝. help, please!
@mrbobbytables, as part of completing the
dependency license allowlist, is it sufficient to report gaps, or is the requirement to be fully compliant to check off the item?
@krook, I have finished this now. We just merged PRs, which will be released soon, that removed third-party libraries with non-approved licenses.
- https://github.com/stateful/vscode-runme/pull/1974
- https://github.com/stateful/runme/pull/747
DCO is now enabled for:
- https://github.com/stateful/runme
- https://github.com/stateful/vscode-runme
- https://github.com/stateful/docs.runme.dev
- [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.
Working on setting up https://github.com/runmedev. First, attempt to transfer the docs website (https://github.com/stateful/docs.runme.dev) to it to make sure we can continue to publish the docs. At that point, it'd be good to associate the org with the CNCF before we migrate the remaining repos. I'm trying to avoid release/pipeline downtime.
- [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.
Working on setting up https://github.com/runmedev. First, attempt to transfer the docs website (https://github.com/stateful/docs.runme.dev) to it to make sure we can continue to publish the docs. At that point, it'd be good to associate the org with the CNCF before we migrate the remaining repos. I'm trying to avoid release/pipeline downtime.
The org with the first repo docs.runme.dev transferred is ready now. Successfully published the docs. Can we please associate the org with the CNCF, @krook? Before I'll go ahead and move the higher stakes repos.
Can you please ping me when the project is moved to a separate GitHub org? I will then update DevStats to track that org.
@sourishkrout I've invited https://github.com/runmedev to our GHE
@lukaszgryglicki that's the new org
@sourishkrout I've invited https://github.com/runmedev to our GHE
@lukaszgryglicki that's the new org
Accepted the invite 👍. Lemme know if everything looks okay on your side.
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.
- Add
thelinuxfoundationas an an organization owner, if it's not already one.
✅ done.
- Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
I believe somebody has to trigger installing the app so an owner can improve it inside the runmedev org.
FYI, I will move the other two repos to the new org this week.
Repos were moved, @krook @lukaszgryglicki:
- https://github.com/runmedev/runme
- https://github.com/runmedev/runmejs
- https://github.com/runmedev/vscode-runme
- https://github.com/runmedev/docs.runme.dev
- 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 CNCF staff.
@sourishkrout are there any updates on onboarding tasks you may have already completed?
@krook We are currently working through these. I'll let you know when they complete.
- [ ] 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.
@krook I sent you a slack message, but if you have instructions on how to transfer the analytic I would appreciate it! 🙏
@krook I sent you a slack message, but if you have instructions on how to transfer the analytic I would appreciate it! 🙏
@chalin is this something you can connect with @admc on please?
The landscape entry is added - https://github.com/cncf/landscape/pull/4332
@admc do you have a preference for FOSSA or Snyk for license scanning?
@krook I do not seem to have email addresses registered for the maintainer team. Can you PTAL?
