sandbox icon indicating copy to clipboard operation
sandbox copied to clipboard

Published 20 hours ago • verified publisher icon cncf

[SANDBOX PROJECT ONBOARDING] Koordinator

Open jeefy opened this issue 1 year ago • 40 comments
trafficstars

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 into the Sandbox.

We would like to complete onboarding within one month of acceptance.

From the project side, please ensure that:

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 Service Desk - [email protected] is the best email to send those to
  • [ ] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement.
  • [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project
  • [x] Ensure that DCO or CLA are enabled for all GitHub repositories of the project
  • [x] 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] Ensure LF footer is on your website and guidelines followed (if your project doesn't have a dedicated website, please adopt those guidelines for the README file of your project on GitHub).
  • [x] Transfer website analytics to [email protected]
  • [x] Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en

Things that the CNCF will do or help the project to do:

jeefy avatar Apr 16 '24 19:04 jeefy

DevStats instance added, adding to "All CNCF" instance in progress, researching affiliations in progress.

lukaszgryglicki avatar Apr 19 '24 10:04 lukaszgryglicki

Project added to All CNCF DevStats instance, also included in projects health dashboards here and there.

lukaszgryglicki avatar Apr 23 '24 10:04 lukaszgryglicki

You submit a pull request to add your project as a Sandbox project to https://landscape.cncf.io/

Landscape added

hormes avatar Apr 23 '24 11:04 hormes

Your project in its own separate neutral GitHub organization. This will make it transferable to the CNCF's GitHub Enterprise account.

Koordinator is in a separate GitHub organization.

hormes avatar Apr 23 '24 11:04 hormes

Your Slack channels are migrated to the Kubernetes or CNCF Slack workspace. See https://slack.com/help/articles/217872578-Import-data-from-one-Slack-workspace-to-another for more details)

The Slack channel of Koordinator is already in the Kubernetes Workspace.

songtao98 avatar Apr 25 '24 08:04 songtao98

Hello @jeefy !

We have already addressed the following items from the list. Please take a look when you're available and contact me if there's any problem :)

From the project side, please ensure that:

  • [x] You understand the project proposal process and requirements: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introduction
  • [x] You understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
  • [x] You ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
  • [x] You review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
  • [x] You understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/
  • [x] You understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
  • [x] Your project is working on written, open governance. See https://contribute.cncf.io/maintainers/governance/
  • [x] Your Slack channels are migrated to the Kubernetes or CNCF Slack workspace. See https://slack.com/help/articles/217872578-Import-data-from-one-Slack-workspace-to-another for more details) Slack channel of Koordinator is under the Kubernetes workspace.
  • [x] Your project in its own separate neutral GitHub organization. This will make it transferable to the CNCF's GitHub Enterprise account. Koordinator is in a Separate GitHub organization.
  • [x] You submit a pull request to add your project as a Sandbox project to https://landscape.cncf.io/ Landscape added.
  • [x] You create maintainer list + add to aggregated https://maintainers.cncf.io/ list by submitting a PR to it Here is the PR with our maintainer list: https://github.com/cncf/foundation/pull/795
  • [x] You submit a pull request to https://github.com/cncf/artwork with your artwork Here is the PR with our artwork: https://github.com/cncf/artwork/pull/473
  • [x] You transfer your 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 Service Desk - [email protected] is the best email to send those to I have sent an email to provide maintainers' email addresses to [email protected].
  • [ ] Transfer any trademark and logo assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
  • [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project
  • [x] Ensure that DCO or CLA are enabled for all GitHub repositories of the project. DCO is enabled in Koordinator.
  • [x] Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub. Koordinator referenced CNCF Code of Conduct in README.
  • [x] Ensure LF footer is on your website and guidelines followed (if your project doesn't have a dedicated website, please adopt those guidelines for the README file of your project on GitHub). See this PR: https://github.com/koordinator-sh/website/pull/176
  • [x] Transfer website analytics to [email protected] We don't use website analytics currently.
  • [x] Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en Koordinator OpenSSF Best Practices Badge: OpenSSF Best Practices See it in README

songtao98 avatar Apr 25 '24 09:04 songtao98

@jeefy hi, PTAL:

We're working on these remaining tasks with legal help, still need some time.

  • [ ] You transfer your domain to the CNCF - https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/create/63
  • [ ] Transfer any trademark and logo assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements

For task: Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project. We need your help with invitation.

songtao98 avatar May 09 '24 03:05 songtao98

For task: Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project. We need your help with invitation.

@songtao98 I've invited you to the CNCF GHE account

krook avatar May 13 '24 14:05 krook

I have updated the checklist and it is accurate as of today!

Cmierly avatar May 13 '24 21:05 Cmierly

For task: Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project. We need your help with invitation.

@songtao98 I've invited you to the CNCF GHE account

@krook Thanks for your invitation! Koordinator has received an email with a message that you has completed the invitation and there's no extra link for us to accept. Please let us know if there's anything else we should do to check this task.

songtao98 avatar May 14 '24 01:05 songtao98

Koordinator is now in GHE with thelinuxfoundation as an owner, and it's onboarded to Insights.

krook avatar May 17 '24 21:05 krook

@Cmierly hi, I've sent an email to [email protected] to explain about the issue of our maintainer's email address. Another email was to ask about how can we transfer our domain and trademarks. I was wondering if there have been any updates on these two issues? Your feedback would be greatly appreciated.

songtao98 avatar May 27 '24 01:05 songtao98

I emailed out invites to join FOSSA and Snyk to @hormes @FillZpp @jasonliu747 @zwzhang0107 @songzh215 @j4ckstraw @lucming @eahydra

From there, any of the maintainers who have accepted their invites can add code repos for scanning.

RobertKielty avatar May 28 '24 09:05 RobertKielty

I emailed out invites to join FOSSA and Snyk to @hormes @FillZpp @jasonliu747 @zwzhang0107 @songzh215 @j4ckstraw @lucming @eahydra

From there, any of the maintainers who have accepted their invites can add code repos for scanning.

@RobertKielty Thanks a lot! But how about our maintainer @kangclzjc ?

songtao98 avatar May 28 '24 09:05 songtao98

Hi @songtao98, @kangclzjc was not on the internal list of maintainers for the project. Have you sent their email address into us?

cc @Cmierly

edit. Also, important to note that any mainatianer that has repo access to project code can add those repos to be scanned on FOSSA.

RobertKielty avatar May 28 '24 11:05 RobertKielty

Hi @songtao98, @kangclzjc was not on the internal list of maintainers for the project. Have you sent their email address into us?

cc @Cmierly

edit. Also, important to note that any mainatianer that has repo access to project code can add those repos to be scanned on FOSSA.

@RobertKielty Yes I think so. @kangclzjc has already received the invitation from @Cmierly to become the maintainer and was also merged into the maintainer list by https://github.com/cncf/foundation/pull/795 The email address is REDACTED

songtao98 avatar May 28 '24 11:05 songtao98

We generally avoid posting email addresses in comments here. I've captured the email address so you can remove it from your last comment.

RobertKielty avatar May 28 '24 11:05 RobertKielty

We generally avoid posting email addresses in comments here. I've captured the email address so you can remove it from your last comment.

It's ok I removed it.

RobertKielty avatar May 28 '24 11:05 RobertKielty

I have sent a FOSSA invite to @kangclzjc

Let me know when the invite is accepted ans I will add you to the Koordinator team.

RobertKielty avatar May 28 '24 12:05 RobertKielty

I have sent a FOSSA invite to @kangclzjc

Let me know when the invite is accepted ans I will add you to the Koordinator team. @RobertKielty yes, I received the invitation and accepted. Thanks a lot.

kangclzjc avatar May 29 '24 01:05 kangclzjc

I have sent a FOSSA invite to @kangclzjc

Let me know when the invite is accepted ans I will add you to the Koordinator team.

Hi, @RobertKielty one of our maintainer @lucming didn't received your invitation email to join FOSSA. And also has problem with invitation to join as maintainer. We need your help with @lucming 's email address and invitations. cc @Cmierly

songtao98 avatar May 29 '24 03:05 songtao98

@RobertKielty Sorry for the inconvenience. To add project code repos to be scanned on FOSSA, it requires users login with their GitHub account. Some of our maintainers provided email addresses that are different from their GitHub-used email. Is it possible that we change their email address in maintainer list and then you could send new invitations to them?

songtao98 avatar May 29 '24 08:05 songtao98

@songtao98 no need to apologise at all, we are happy to make any accomodations required to get the license scans setup in FOSSA or Snyk.

Best thing to do would be to work through this on a DM over on CNCF Slack. I will reach out to you there.

RobertKielty avatar May 29 '24 09:05 RobertKielty

@songtao98 it was great to meet with you today.

I appreciate you for taking the time to talk with me to set up license scanning for the project.

As a result of our work we now have project maintainers that are setup on both FOSSA and Snyk.

Next step here is to import project code repos into FOSSA and/or Snyk and then we can call this done. If the maintainers have any problems importing projects get them to reach out to me and I will support them.

Together we noted that maintainer email addresses used to onboard projects on to services that interact with GitHub repos must be associated with GitHub Accounts that have the access to the project's GitHub org so that service such as FOSSA and Snyk can sucessfully import repos from GitHub for scanning.

We also noted issues around domain blocking on some services that we use.

I will present both issues to the projects team for discussion on how we can improve our processes and record keeping to accomodate multiple email addresses or service-specific email addresses.

cc @jeefy @krook @Cmierly

RobertKielty avatar May 29 '24 11:05 RobertKielty

@songtao98 it was great to meet with you today.

I appreciate you for taking the time to talk with me to set up license scanning for the project.

As a result of our work we now have project maintainers that are setup on both FOSSA and Snyk.

Next step here is to import project code repos into FOSSA and/or Snyk and then we can call this done. If the maintainers have any problems importing projects get them to reach out to me and I will support them.

Together we noted that maintainer email addresses used to onboard projects on to services that interact with GitHub repos must be associated with GitHub Accounts that have the access to the project's GitHub org so that service such as FOSSA and Snyk can sucessfully import repos from GitHub for scanning.

We also noted issues around domain blocking on some services that we use.

I will present both issues to the projects team for discussion on how we can improve our processes and record keeping to accomodate multiple email addresses or service-specific email addresses.

cc @jeefy @krook @Cmierly

@RobertKielty Great meet and great summary! Thanks a lot! We'll work on the remaining issues ASAP ：）

songtao98 avatar May 29 '24 11:05 songtao98

@RobertKielty hi, Koordinator is now imported within both FOSSA and Snyk for scanning. Could you please check if it meets the requirement to complete the tickbox for onboarding?

songtao98 avatar May 31 '24 02:05 songtao98

@songtao98 thank you for finishing this out, the FOSSA scan report is here

@jeefy can you please take a look at the three issues found by FOSSA and let us know what action needs to be taken, to remedy or close them out?

As the license scan tool adoption has been completed I have marked this as done.

RobertKielty avatar May 31 '24 14:05 RobertKielty

@jeefy Hi, we have some problems about how to properly transfer our domain and trademarks. We have sent an email to [email protected]. Would you like to check about these issues so that we can finish Koordinator's onboarding?

songtao98 avatar Jun 04 '24 08:06 songtao98

@jeefy @Cmierly Hi, would you please check the status of our issue to transfer domain and trademarks?

songtao98 avatar Jun 20 '24 03:06 songtao98

@caniszczyk @jeefy @Cmierly Hi, we are working on our trademark and logo assets agreements, and will recently finish this process. May I ask what exactly do we do about the Domain transfer? Will CNCF be resposible for DNS after this transfer, too?

songtao98 avatar Oct 24 '24 04:10 songtao98