cncf
[PROJECT ONBOARDING] Tokenetes (formerly Tratteria)
Welcome to CNCF Project Onboarding
Sandbox Reference Issue: https://github.com/cncf/sandbox/issues/115
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 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.
REQUIRED BEFORE PROCEEDING WITH ONBOARDING
A "Project Contribution Agreement" must be completed and any existing trademarks MUST be transferred to the Linux Foundation BEFORE CNCF staff onboarding tasks can be completed.
- [ ] Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
- [ ] Review and understand the LF trademark guidelines.
- [x] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement. CNCF staff will send this document to the contact emails listed in the Sandbox application.
Review and understand other documents
- [ ] 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 dependency license allowlist.
- [ ] The online program guidelines.
- [ ] The telemetry data collection and usage policy.
- [ ] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer other materials
- [x] 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.
- [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add
thelinuxfoundationas 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.
- [ ] Join the #maintainers-circle Slack channel.
- [ ] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
- [ ] Submit a pull request with your artwork.
- [ ] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document project details
- [ ] Ensure that DCO (preferred) 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.mdon 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.mdfile). The project-specific footer text you should use will be provided in the Contribution Agreement instructions. - [ ] 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 and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [ ] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks to support the project
- [x] Add the project to DevStats.
- [x] Add the project to CLOmonitor.
- [x] 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.
- [x] Add the project to LFX Project Control Center.
- [ ] Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [ ] Add a license scanning tool, like FOSSA or Snyk.
- [ ] Send a welcome email to confirm maintainer list access.
Hi @mrbobbytables, thanks for getting this kicked off. I have one question. We have received feedback that the name "tratteria" is hard to remember and also gets autocorrected to "trattoria" anytime someone types it. We are thinking of looking for a new name for the project and rebranding it.
Would it be better to explore rebranding the project before we brought it into the CNCF Sandbox or afterwards?
Ideally beforehand, there’s a lot of places where the name would have to be updated. It’d at least make trademark transfer easy - once a name is assigned can actually establish once joined
Welcome to the CNCF Sandbox @tulshi and the Tratteria team!
CNCF staff is working on the first step, which is to create and share the Contribution Agreement with you shortly.
I'll send an email to the contacts listed on the Sandbox application. The Contribution Agreement can be signed by the contributing organization, or a group of individuals.
To echo @mrbobbytables point, a name change should be done before the Contribution Agreement is signed.
Welcome again to the CNCF Sandbox! We're creating the Contribution Agreement document for you now and should have it to you shortly.
In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.
Sounds good. I've reviewed some of the documents. We've also decided to rename the project to "Tokenetes"
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.
Hi folks, as we work through the Contribution Agreement task, please let us know if you've completed any of these other tasks.
@krook , please note that we are going through a temporary resource crunch. We should be able to pick up the work in the first week of April.
@krook , please note that we are going through a temporary resource crunch. We should be able to pick up the work in the first week of April.
No problem @tulshi. Just let us know as you're able to progress on items and we'll check them off here.
Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:
- Add
thelinuxfoundationas an an organization owner, if it's not already one. - Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
- Add
thelinuxfoundationas an an organization owner, if it's not already one.- Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
This has now been done by CNCF staff.
@krook , please note that we are going through a temporary resource crunch. We should be able to pick up the work in the first week of April.
Hi @tulshi were there any other items we can mark complete?
Hi, I believe this step: "Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project." is done. Please check
Hi @krook I have:
- Initiated a domain transfer to CNCF and named you as the CNCF contact.
- Created a PR for the artwork
- Joined the "#maintainers-circle" Slack channel
- There are no website analytics or slack channels at the moment.
- Updated the LF Footer at tokenetes.io to match CNCF guidelines
Please mark these bits appropriately in this issue.
@tulshi let me know if you have a preference for FOSSA or Snyk for license scanning and I can set you up on your preferred service.
Please mark these bits appropriately in this issue.
Thanks @tulshi. List is updated.
@tulshi let me know if you have a preference for FOSSA or Snyk for license scanning and I can set you up on your preferred service.
@RobertKielty I'm not aware of either, so could you please choose whichever you think is appropriate for this project?
@krook we are also on the maintainers list here: https://github.com/cncf/foundation/blob/e4d8d8ceba841ddd574de97188dd3dfa72da3e72/project-maintainers.csv#L1798
Hi, @krook , the following items can also be marked as complete:
- Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
- Review and understand the LF trademark guidelines.
- Join the #maintainers-circle Slack channel.
Also, I noticed that the image link to the Tokenetes logo here and here is incorrect. Is there someone I should follow up with to get them fixed?
@tulshi @kchiranjewee63 I have sent out inviations for you to join CNCF FOSSA, once you have accepted the invitations let me know here, I will add you to the team I have creted for you there.
Also, I noticed that the image link to the Tokenetes logo here and here is incorrect. Is there someone I should follow up with to get them fixed?
Those two pages are driven by data from the landscape. The Tokenetes entry refers to a tokenetes.svg that doesn't seem to exist there. Either you or @idvoretskyi can send a PR to add that file.
@tulshi also, can you please add the logo here - https://github.com/cncf/artwork/tree/main/projects, so it would act as a source of truth.
@tulshi also, can you please add the logo here - https://github.com/cncf/artwork/tree/main/projects, so it would act as a source of truth.
It's already there: https://github.com/cncf/artwork/tree/main/projects%2Ftokenetes
@tulshi and @kchiranjewee63 thank you for acceptnig the invitation to join CNCF FOSSA.
I have added you both as Team Admins to the Tokenetes team there.
Please follow the instructions on
https://docs.fossa.com/docs/quick-import
to import your code repos into and when that is done let me know.
Thanks @RobertKielty , I've imported the Tokenetes organization (all repos) to FOSSA.