[SANDBOX PROJECT ONBOARDING] Atlantis

[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.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
• 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 LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
• Add a license scanning tool, like FOSSA or Snyk.
• Send a welcome email to confirm maintainer list access.

[lukaszgryglicki]

DevStats instance added, project also added to All CNCF projects health.

[jamengual]

Who can we contact for the Slack migration? We are wondering if we can keep our slack and get the slack message history somehow? We have 2k users in there and a very active community.

[idvoretskyi]

@jamengual feel free to file a ticket at the CNCF ServiceDesk - https://servicedesk.cncf.io/, I'm happy to assist you.

[RobertKielty]

I have sent out invites to join FOSSA and Snyk to the three registered maintainers.

@jamengual has accepted both the FOSSA and Snyk invites.

[RobertKielty]

FOSSA Setup is complete with 4 scanned repos setup.
Snyk Setup complete with 3 imported projects.

[RobertKielty]

Spoke with @jamengual about Slack and laid out the following plan

On the Atlantis workspace, renmame the channels that are to be migrated over to the cloud-native workspace so that they start with atlantis-

Export the channels this week, then I will migrate them end of week.

[RobertKielty]

@jamengual reached out to me to let me know that we can work together on the Slack migration tomorrow (Oct 2nd)

@krook a community member has created an #Atlatnis channel on Cloud Native Slack so we will work with them to grant control to the Atlantis project maintainers.

[GenPage]

@Cmierly Update :

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.

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.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• 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 LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
• Add a license scanning tool, like FOSSA or Snyk.
• Send a welcome email to confirm maintainer list access.

[krook]

@GenPage it looks like onboarding is nearly complete.

These are the remaining tasks to be done:

• Transfer the runatlantis.io domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
• Transfer website analytics to [email protected]. CNCF staff can help.
• Ensure LF footer is on your website and guidelines are followed.

[krook]

Ping @GenPage. Any progress on these last onboarding items?

[jamengual]

@krook Domain transfer has been initiated

[jamengual]

We just added the footer
And we do not have access to the old analytics, so we could just send them to whatever account we need to.

[krook]

Excellent, thanks @jamengual. I saw the Service Desk ticket. I've assigned that to the person who can work on the next step.

[chalin]

@jamengual et all: the GA4 property and ID have been created, and a PR submitted. For details, see https://cncfservicedesk.atlassian.net/browse/CNCFSD-2686.

[jamengual]

@jamengual et all: the GA4 property and ID have been created, and a PR submitted. For details, see https://cncfservicedesk.atlassian.net/browse/CNCFSD-2686.

PR merged and site should be already updated.

Thanks!

[chalin]

PR merged and site should be already updated.

As mentioned in runatlantis/atlantis#5361 (comment), I confirm that analytics data is being received.

[krook]

Wonderful, thank you @chalin!

Since the final step was optional and in support of the other onboarding tasks, I'll mark it complete and we can call onboarding done!

Thank you @jamengual!