toc

toc copied to clipboard

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/en/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] Have added your project to https://github.com/cncf/contribute
• [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
• [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
• [x] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
• [x] GitHub: ensure that hat 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).
• [ ] Website: Analytics transferred to [email protected]
• [x] CII: Start on a CII 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] Marketing: update relevant intro + slide decks
• [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, welcome email has monthly project sync details
• [x] Create space for meetings/events on https://community.cncf.io, e.g., https://community.cncf.io/pravega-community/ - (https://github.com/cncf/communitygroups/blob/main/README.md#cncf-projects)
• [x] Adopt a license scanning tool, like FOSSA or Snyk

DevStats page added.

@bsctl, @prometherion, @MaxFedotov, @oliverbaehler - dropping a note in here. Landscape is important - this will get you listed on the sandbox projects page!

👋🏻 just a brief update on this: we're actively working on CLASTIX's repository with an umbrella issue while we track the required steps.

We have a doubt about the project which is using some API types with the previous organization name, such as capsule.clastix.io: although moving the repository over to a new organization is not a big problem, at the current time, seamless migration of the API type is not yet in place since it requires a sizeable amount of time and resources, such as writing converters, and ensuring these work properly without side effects giving the amount of organizations using it in production environments.

Is it acceptable to postpone the removal of any CLASTIX mention from the code base to preserve backward compatibility with previous production installations?

A new organization (Project Capsule) has been created, as well as the GitHub profiles have been invited (@caniszczyk @thelinuxfoundation).

I think that the task:

Have added your project to https://github.com/cncf/contribute

is already completed by https://github.com/cncf/tag-contributor-strategy/commit/284b73abbef2862bebff41a681880b8fb61d4adc.

The task:

Create maintainer list + add to aggregated https://maintainers.cncf.io/ list by submitting a PR to it

is ready for review:

• issue: https://github.com/cncf/foundation/issues/647
• PR: https://github.com/cncf/foundation/pull/648

Hi @maxgio92 ! my name is Crystal and I am the new project coordinator in charge of onboarding sandbox projects!

I have updated the task list for you and will look into your maintainer list PR ASAP

If you have any questions or concerns regarding onboarding tasks, please don't hesitate to reach out!

Hi @Cmierly, thank you.

I think that the following goals have been achieved. You can review them:

1. Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introduction

2. Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/

3. Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md

4. Understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/

5. Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist

6. 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)

7. Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io/

8. GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project

9. GitHub: ensure that hat the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub

Thanks! I've updated the task list!

Thank you @Cmierly. Also the goals:

• Create maintainer list + add to aggregated https://maintainers.cncf.io/ list by submitting a PR to it

• Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy

are now achieved :)

• Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk

I've just sent the email to the proper email address.

Hi @Cmierly, I'd have a question about:

• Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org

You will install the LFX Insights app in the GitHub repository after the project is migrated to the new GitHub organization, isn't it?

• CII: Start on a CII best practices badge https://bestpractices.coreinfrastructure.org/en

This has been already implemented.

You will install the LFX Insights app in the GitHub repository after the project is migrated to the new GitHub organization, isn't it?

Correct. More details on this:

LFX Insights provides projects with more visibility into their community dynamics around contributors, organizations, issues, and pull request metrics. It v3 uses crowd.dev under the hood to gather data about certain repositories in a GitHub organization.

The way it does this is through an app installed (similar to the DCO bot) at the organization level. This is then connected to one or more public repos under the organization. You can see technical details here.

The LFX team will install it on behalf of your project using the Linux Foundation id GitHub id you granted access to earlier, so no action is needed on the project maintainer side. Once your project is onboarded, you'll see data flowing into the dashboards at the LFX Insights v3 site.

Is your project in its own separate neutral github organization

Capsule is now available on its neutral organization: https://github.com/projectcapsule

@thelinuxfoundation has not yet accepted the invitation.

Thank you @prometherion.

I've sent an invitation to the org owners to join the CNCF GitHub Enterprise umbrella org.

Once you accept that, we can onboard @thelinuxfoundation id onto it.

Accepted, thanks @krook

@krook the @thelinuxfoundation invitation was withdrawn, I just resent it back.

@Cmierly I sent the GA invitation to the account [email protected] account with the administrator role.

Wondering if this is enough, or if we should move entirely the property: in this latter case, do you have a specific guide for GA4?

Hello @amye, I think that the following points:

• Is your project in its own separate neutral github organization?

• 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).

can be considered completed.

You can give it a check, respectively, at:

• https://github.com/projectcapsule/capsule.
• https://capsule.clastix.io/

Thank you

Hi @amye, I think that also the following goal:

• Adopt a license scanning tool, like FOSSA or Snyk

you can give it a try here.

Thank you

Hi @maxgio92 ! I have gone ahead and updated the task list for you. Thank you so much for the updates and please don't hesitate to ask if you have any questions regarding the remaining tasks that need to be completed!

Thank you @Cmierly

Hi @maxgio92 ! Have you had the chance to work on any of the remaining tasks? It looks like Capsule only has 3 tasks to complete on your end to finish up with onboarding!

Hi @Cmierly, yes, we're working on the remaining points.

In the meantime you can consider the task

Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements

completed, as we don't have registered trademarks. cc @bsctl @prometherion

I'll update you as soon as possible, thank you.

Hi @maxgio92 ! If your project doesn't have any registered trademarks then you will need to submit a no registered trademark agreement agreement

Added to LFX Insights

• Insights documentation
• Insights support
• Insights feedback

Thank you @krook and @Cmierly. I'll be back ASAP

The artwork item has been completed via cncf/artwork#440

@Cmierly Hello Crystal, how to submit the no registered trademark agreement to CNCF? It's a signed PDF, need to send it through an email? Thank you.