Closed
Description
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.
We would like to complete onboarding within one month of acceptance.
From the project side, please ensure that you:
- Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introductionUnderstand the services available for your project at CNCF https://www.cncf.io/services-for-projects/Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policyReview the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.mdUnderstand the trademark guidelines: https://www.linuxfoundation.org/legal/trademark-usageUnderstand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlistIs your project working on written, open governance? see https://contribute.cncf.io/maintainers/governance/Slack: Are your slack channels migrated to the Kubernetes or CNCF Slack? (see https://slack.com/help/articles/217872578-Import-data-from-one-Slack-workspace-to-another for more details)Is your project in its own separate neutral github organization?Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.ioCreate maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to itArtwork: Submit a pull request to https://github.com/cncf/artwork with your artworkDomain: transfer domain to the CNCF - https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/create/63
Things that CNCF will need from the project:
- Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk - project-onboarding@cncf.io is the best email to send those toTrademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreementsGitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership that we will onboard to our GitHub Enterprise instance: https://github.com/enterprises/cncfGitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHubWebsite: ensure LF footer is there and website guidelines followed (if your project doesn't have a dedicated website, please adopt those guidelines to the README file of your project on GitHub).Website: Analytics transferred to projects@cncf.ioOpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en
Things that the CNCF will do or help the project to do:
- Devstats: add to devstats https://devstats.cncf.io/Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org/Events: update CFP + Registration + CFP Area formsServiceDesk: confirm maintainers have read https://www.cncf.io/services-for-projects/CNCF Welcome Email Sent to confirm maintainer list accessBook time with the team with http://project-meetings.cncf.io
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
bridgetkromhout commentedon Jul 3, 2023
Thanks, @amye! We will begin work on the project-level tasks soon (summer vacations being what they are).
lukaszgryglicki commentedon Jul 4, 2023
DevStats instance added. Also added in All CNCF projects health instance. Will be fully-added to all other All CNCF dashboards on Friday (affiliations research started today, and will be imported as it progresses).
salaxander commentedon Jul 6, 2023
@amye - I'm back from vacation starting now so we'll get started on these items this week and into next week :)
CC @sozercan @pmengelbert @ashnamehrotra
salaxander commentedon Jul 11, 2023
Pasting the list in a new comment so it will allow me to check off progress :)
From the project side, please ensure that you:
Things that CNCF will need from the project:
salaxander commentedon Aug 31, 2023
@amye - Now that the logo is added to /artwork, our onboarding is officially complete :)
amye commentedon Aug 31, 2023
Last thing: "Adopt a license scanning tool, like FOSSA or Snyk" ?
amye commentedon Aug 31, 2023
Also, trademarks: we have agreements for both registered and non-registered. I don't have anything from you on that yet.
salaxander commentedon Aug 31, 2023
@amye We've adopted FOSSA, is the ask to get the badge added to the README? I'll get the licensing doc over to you today. Sorry for the delay on that, I originally thought the only action there was to reference LF as the trademark owner in the license text.
Cmierly commentedon Dec 13, 2023
Hi @salaxander !
My name is Crystal and I am in charge of assisting new sandbox projects with onboarding!
Were you able to get the trademark agreement signed and sent?
krook commentedon Jan 19, 2024
Hello Eraser team! I’ve invited your GitHub organization to the CNCF GitHub Enterprise account.
Once you accept the invitation, we can then confirm
thelinuxfoundation
is an owner, and then onboard you to LFX Insights (which is a matter of adding an app, similar to adding the DCO bot) which uses read only, public data to drive the reports on the Insights dashboard.That would mark these two checklist items as up-to-date and complete (and it supersedes the need to add Chris and I as owners):
thelinuxfoundation
,caniszczyk
, andkrook
are added as initial org owners, this helps us make sure we have continuity of GH ownership while we onboard you to our GitHub Enterprise instance: https://github.com/enterprises/cncfYou can learn more about Insights here:
Please let me know if you have any questions about onboarding GHE and/or Insights.
krook commentedon Jan 19, 2024
Thanks for accepting the GitHub Enterprise invitation.
CNCF staff can now add
thelinuxfoundation
as an organization owner and then install the Insights app on the org.Please let me know if you have any questions or concerns before we do that @sozercan.
sozercan commentedon Jan 20, 2024
thanks @krook!
thelinuxfoundation
,caniszczyk
, andkrook
should be owners in the org now.krook commentedon Jan 31, 2024
Thanks @sozercan
The LFX Insights onboarding task is now marked complete on the CNCF side.
Once the initial data load finishes, I'll share a link to your project-specific dashboard where you can explore dashboards and reports. It should be ready for you by the end of the week.
krook commentedon Feb 1, 2024
@sozercan Insights data loading is complete. You can now check out the Eraser-specific dashboard here.
Through the left nav, you can go through the Overview, Velocity, and Productivity dashboards. There is also a set of info on Contributors, Organizations, and Activities under the Reports section. All of them can be filtered by timeframe.
You can find Insights documentation here, file tickets if something doesn't look right (v3 is in beta so any reports are very helpful), and post public feedback at this forum topic.
Cmierly commentedon Feb 8, 2024
Eraser has completed onboarding!