toc
toc copied to clipboard
cncf
[SANDBOX PROJECT ONBOARDING] Xline
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:
- [x] Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introduction
- [x] Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
- [x] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
- [x] Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
- [x] Understand the trademark guidelines: https://www.linuxfoundation.org/legal/trademark-usage
- [x] Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
- [x] Is your project working on written, open governance? see https://contribute.cncf.io/maintainers/governance/
- [x] 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)
- [x] Is your project in its own separate neutral github organization?
- [x] Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io
- [x] Create maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to it
- [x] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
- [x] Domain: transfer domain to the CNCF - https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/create/63
Things that CNCF will need from the project:
- [x] Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk - [email protected] is the best email to send those to
- [x] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
- [x] GitHub: 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/cncf
- [x] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
- [x] GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub
- [x] Website: 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).
- [x] Website: Analytics transferred to [email protected]
- [x] OpenSSF 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:
- [x] Devstats: add to devstats https://devstats.cncf.io/
- [x] Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org/
- [x] Events: update CFP + Registration + CFP Area forms
- [x] ServiceDesk: confirm maintainers have read https://www.cncf.io/services-for-projects/
- [x] CNCF Welcome Email Sent to confirm maintainer list access
- [ ] Book time with the team with http://project-meetings.cncf.io
- [x] Adopt a license scanning tool, like FOSSA or Snyk
The CNCF Code of Conduct is referenced in the project readme. FYI: https://github.com/datenlord/Xline#code-of-conduct
@Phoenix500526 is there plans to move xline to a neutral github org? e.g. github.com/xline
Regarding the following point, I have some questions:
GitHub: 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/cncf
In GitHub, the concept of "owner" exists only for organizations, while repositories have the concepts of "collaborators" and permissions. I have already invited caniszczyk and thelinuxfoundation as collaborators for the Xline repository and granted them admin permissions. But I feel like something might be wrong. Shall we create a new org called Xline and transfer the Xline repo to this org, and then add caniszczyk and thelinuxfoundation as owners of the Xline org? Thank you for your response.
Are there any specific requirements for the org name? The name "xline" has already been taken. Can we use "xline.kv" as the org name instead? @amye @caniszczyk
Are there any specific requirements for the org name? The name "xline" has already been taken. Can we use "xline.kv" as the org name instead? @amye @caniszczyk
You can do whatever makes sense for the project as long as it indicates that it's a separate organization.
@caniszczyk Xline has been moved to a neutral GitHub org. FYI: https://github.com/xline-kv. DCO is on for all repos in the xline-kv.
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).
Hello @amye We are completing the onboarding checklist, and I have a couple of questions: 1. Xline does not have a slack channel, and we may not be able to migrate it to the Kubernetes or CNCF Slack. [Xline uses Discord instead] 2. Since Xline's official website is currently a static website and does not collect visitor information, we cannot transfer analytics such as PV/UV, etc. Then, what can we do at this point of time, any suggestions? Thank you~
The OpenSSF Best Practices Badge is added. FYI: https://github.com/xline-kv/Xline#readme @amye
Can you confirm by checking off this list?
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#introduction Understand 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-policy Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md Understand the trademark guidelines: https://www.linuxfoundation.org/legal/trademark-usage Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist Is 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.io/ Create maintainer list + add to aggregated https://maintainers.cncf.io/ list by submitting a PR to it Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork Domain: 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 - [email protected] is the best email to send those to Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements GitHub: 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/cncf GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub Website: 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 [email protected] OpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en
From the project side, please ensure that you:
- [X] Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introduction
- [X] Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
- [X] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
- [X] Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
- [X] Understand the trademark guidelines: https://www.linuxfoundation.org/legal/trademark-usage
- [X] Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
- [X] Is your project working on written, open governance? see https://contribute.cncf.io/maintainers/governance/
- [X] 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)
- [X] Is your project in its own separate neutral github organization?
- [X] Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io/
- [X] Create maintainer list + add to aggregated https://maintainers.cncf.io/ list by submitting a PR to it
- [X] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
- [X] Domain: transfer domain to the CNCF - https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/create/63
Things that CNCF will need from the project:
- [X] Provide emails for the maintainers added to https://maintainers.cncf.io/ in order to get access to the maintainers mailing list and ServiceDesk - [email protected] is the best email to send those to
- [X] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
- [ ] GitHub: 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/cncf
- [X] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
- [X] GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub
- [X] Website: 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).
- [X] Website: Analytics transferred to [email protected]
- [X] OpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en
Currently, 'caniszczyk' is added as the initial org owner. We have sent two invitations to 'thelinuxfoundation', but he has not accepted the invitations so far. Can we checkoff the item "GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners"? @amye
Send another invite to 'thelinuxfoundation' and I'll see what I can do to pick that up!
Send another invite to 'thelinuxfoundation' and I'll see what I can do to pick that up!
OK, I have sent the invitation.
I created a FOSSA Team and a Snyk org for xline.
We next need to create a GitHub Profile associated with the maintainers email addr on Groups.io.
I posted a message to the maintainer list on groups.io to explain next steps.
Execute me, does that mean we need to create a mail list on Groups.io? @RobertKielty
Hi @Phoenix500526,
We can use the maintainers group for this, there's no need to make a new group.
@RobertKielty Thanks for your reply. Excuse me, I accidentally forgot to accept the Snyk invitation you sent, and it has expired. Could you please resend it?
Hi @Phoenix500526 ! My name is Crystal and I'll now be in charge of assisting sandbox projects with the onboarding process! I'm checking in to see if you received a new invitation to Snyk?
Execute me, do we need to add information to these LFX Insights? @krook
@Phoenix500526 no, you don't need to add anything to it. It is enabled for your most popular repo, but you can let us know if you want to get reports on your secondary repos as well.
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.
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.