[SANDBOX PROJECT ONBOARDING] Cartography

[Cmierly]

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

Review and understand

• The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
• The project proposal process and requirements.
• The services available for your project at the CNCF.
• The CNCF IP Policy.
• The trademark guidelines.
• The license allowlist.
• The online program guidelines.
• Optional: Book time with CNCF staff for any onboarding questions.

Contribute and transfer

• 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.
• 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.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
• Transfer any trademark and logo assets to the Linux Foundation.
• Submit a pull request with your artwork.
• Transfer website analytics to [email protected]. CNCF staff can help.

Update and document

• 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 on 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 file).
• 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.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks

• Add the project to DevStats.
• Add the project to CLOmonitor.
• 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.
• Add the project to LFX Project Control Center.
• Add a license scanning tool, like FOSSA or Snyk.
• Invite developers to the #maintainers-circle Slack channel.
• Send a welcome email to confirm maintainer list access.

[lukaszgryglicki]

DevStats instance ready.

[lukaszgryglicki]

Project added do Project Health and All Projects Health.

[krook]

Hi Cartography team. In order for us to add the project to GitHub Enterprise, it will need to moved into its own neutral GitHub organization. Currently it is still under the Lyft organization: https://github.com/lyft/cartography/

[cynthia-sg]

Project has been added to CLOMonitor

[achantavy]

Hi @krook, thanks for the reminder -- we will aim to make the organization transfer early next week. We are currently getting the trademark transfer paperwork signed.

[achantavy]

Double checking, but is the email to send trademark transfer paperwork still [email protected]?

[achantavy]

@krook (or anyone else) - can you let me know the correct email to send trademark legal paperwork?

[idvoretskyi]

Double checking, but is the email to send trademark transfer paperwork still [email protected]?

Sent it this way, please.

[achantavy]

Here are some updates:

Contribute and transfer

• Transfer any trademark and logo assets to the Linux Foundation.

This is done! The trademark transfer agreement is now fully executed so CNCF is now the owner :).

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

We are working on this tomorrow.

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

Can you please invite the https://github.com/cartography-cncf GitHub org?

• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.

We would like to move the #cartography channel over from the Lyft OSS Slack workspace -- who is the right person that can help here?

[krook]

Can you please invite the https://github.com/cartography-cncf GitHub org?

Invite sent.

We would like to move the #cartography channel over from the Lyft OSS Slack workspace -- who is the right person that can help here?

Paging @RobertKielty

[achantavy]

Crossing out some items today :)

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

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

• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.

Submitted cncf/landscape#4093.

• [N/A] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].

N/A, we will register a domain after we have access to submit a service desk ticket.

• [N/A] Transfer website analytics to [email protected]. CNCF staff can help.

N/A

---

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

[krook]

Thanks @achantavy. The checklist has been updated.

[RobertKielty]

@achantavy would you prefer to use FOSSA or Snyk for the license scanning work?

Once you have made that choice, please complete the following task:

Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].

Then I email out the invites to your chosen license scanning service.

[achantavy]

Crossing out some more items:

• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.

Done: cncf/foundation#876

• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].````

Done

• Submit a pull request with your artwork.

Submitted: cncf/artwork#514

---

@RobertKielty: I don't have a strong preference re FOSSA or Snyk, what do most projects use/what do you recommend? Maybe FOSSA?

[achantavy]

Alright, have everything done now except for the Slack transfer

---

Read and understand...

• The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.

• The project proposal process and requirements.

• The services available for your project at the CNCF.

• The CNCF IP Policy.

• The trademark guidelines.

• The license allowlist.

• The online program guidelines.

• Optional: Book time with CNCF staff for any onboarding questions.

Update and document

• Start working on written, open governance.

cartography-cncf/cartography#1372

• Start on an OpenSSF Best Practices Badge.

https://www.bestpractices.dev/en/projects/9637

[achantavy]

Few more follow-up items:

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

This one should be marked done IIUC.

• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].

I sent emails for the maintainers mailing list but haven't heard back, can I please have access to the service desk?

• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.

When you have a chance, can we have some help with the Slack migration? Or do we need access to the service desk first for a ticket?

cc: @RobertKielty @Cmierly

Thanks!

[Cmierly]

Few more follow-up items:

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

This one should be marked done IIUC.

• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].

I sent emails for the maintainers mailing list but haven't heard back, can I please have access to the service desk?

• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.

When you have a chance, can we have some help with the Slack migration? Or do we need access to the service desk first for a ticket?

cc: @RobertKielty @Cmierly

Thanks!

You will need Service Desk Access. I'll get you added today!

[achantavy]

@Cmierly can you add us to the service desk please? Sorry for the bump, I'm hoping 🤞 to write an announcement that we've fully joined by Kubecon

[krook]

@achantavy this is one item you can also do yourselves. Since it's now a public channel, just go ahead and join it:

• Invite developers to the #maintainers-circle Slack channel.

[achantavy]

@krook
Done!

• Invite developers to the #maintainers-circle Slack channel.

[achantavy]

@Cmierly @krook - friendly bump, can we get added to the service desk?

[Cmierly]

@Cmierly @krook - friendly bump, can we get added to the service desk?

Hi!
Two of the Three emails provided have accepted their service desk invite. I resent the invite for the third person. If you need to add new maintainers or change any emails, please let me know!

[achantavy]

• [x ] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.

Slack is now done thanks to @RobertKielty's amazing help 🎉

All of the items are done on the Cartography side. As for FOSSA vs Snyk, I don't have a strong preference, I'll go with whatever you recommend.

Please let me know if anything else is needed.

[RobertKielty]

@achantavy I've sent out invites to all maintainers to join CNCF FOSSA, when you accept those invitations let me know. I then need to add you to the Cartography team there.

[achantavy]

• Add a license scanning tool, like FOSSA or Snyk.

I have added cartography to the CNCF's FOSSA!

[achantavy]

Hi @Cmierly and everyone else, can you help us with the last couple remaining items on this list?

[Cmierly]

Hello @achantavy !
I'll ping @krook so he knows that getting you on LF Insights is the final step in your onboarding

[achantavy]

Hey @Cmierly @krook - friendly bump on this one. Lemme know if I need to do anything else.

[achantavy]

Hey all, bumping this up after the new year

[krook]

Hi @achantavy since we have the trademark doc, I'll work on closing out the final two tasks here. Nothing to do on your side, thanks!

[krook]

Working on the final task here today. Since Cartography is in the CNCF GitHub Enterprise, we can add thelinuxfoundation as a workspace owner and install the LFX Insights read-only app. Then onboarding will be complete 🎉 . Will close this issue when that's done.

[krook]

Congratulations on completing your Sandbox onboarding Cartography! This issue is ready to close.

@achantavy