toc
toc copied to clipboard
[SANDBOX PROJECT ONBOARDING] Inspektor Gadget
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] 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 - [email protected] is the best email to send those to
- [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 that 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).
- [x] Website: Analytics transferred to [email protected]
- [x] OpenSSF Best Practices Badge: Start on an OpenSSF 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
- [x] Book time with the team with http://project-meetings.cncf.io
- [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)
- [ ] Adopt a license scanning tool, like FOSSA or Snyk
I can't check [ ] DevStats checkbox - no idea why.
Inspektor Gadget DevStats page added, not added to All CNCF yet, will add tomorrow or on Friday (All CNCF takes a long time to regenerate andthis must be done to include new projects tstats in the past data as well).
cc @caniszczyk @amye
Project added to Project(s) health dashboards:
- https://all.devstats.cncf.io/d/54/project-health-table?orgId=1&var-repogroup_name=Inspektor%20Gadget.
- https://all.devstats.cncf.io/d/53/projects-health-table?orgId=1 Affiliations initial research done. Still pending the final add (including past data) to All CNCF DevStats instance.
New projects also added to All CNCF including regenerating all dasdhboards past-data for all time.
I wasn't ignoring this, just didn't know about it. If you reference the initial submission and/or @ the submitters it would be really helpful to raise awareness for next steps.
I'll start working through these.
Opening up this comment to track our progress on the above tasks.
- [x] Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introduction 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] 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
@blixtra - Great to have you! Biggest thing is really going to be getting the maintainers lists, things usually fall into place from there. Trademarks tend to be a little sticky, is there someone from your side that can sign a contribution agreement?
@amye Thanks! PR submitted for maintainers. I'll look into the contribution agreement signatory. I don't foresee that being a problem.
@amye Thanks! PR submitted for maintainers. I'll look into the contribution agreement signatory. I don't foresee that being a problem.
Let me know if you need help finding the right person on your side!
@amye Can you please confirm that the agreement we are talking about is one from here: https://github.com/cncf/foundation/tree/main/agreements
Yep! Also, on that PR for maintainers - I've backed it out because without affiliations, it breaks the .csv file! Please resubmit!
Checking in on this one:
- Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io/
This both puts your project on the landscape and the CNCF projects page, so it's pretty important!
Checking in on this one:
- Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io/
This both puts your project on the landscape and the CNCF projects page, so it's pretty important!
Checking in on this one, once this is done you'll be listed on sandbox projects page on the main CNCF website. @blixtra @ahrkrak - can you help?
Seems like something we could do quite quickly. I'll ping @blixtra OOB as well
Hi @blixtra ! My name is Crystal Mierly and I am the new project coordinator in charge of onboarding sandbox projects!
I'm checking in to see if you or your team have had the chance to complete or review any of the remaining tasks on the above list? If you have any questions or concerns, please don't hesitate to reach out, I am happy to help!
I think almost all the items under "Things that CNCF will need from the project" that we can do on our own are done. We addressed some of them just after you posted this.
Hi @blixtra ! Did you happen to have a list of things you have completed so far? I would be happy to check them off for you!
Hi @blixtra ! Did you happen to have a list of things you have completed so far? I would be happy to check them off for you!
@Cmierly The checklist above should be accurate. I don't think there is anything else I can do on my on at this point.
Hi @blixtra,
If you're not able to complete these tasks on your own (and they're not already done), is there someone else from the project that you can ask to complete them?
- [ ] Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
- [ ] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
- [ ] Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk - [email protected] is the best email to send those to
- [ ] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
- [ ] GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership
- [ ] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
- [ ] GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub
- [ ] 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]
- [ ] OpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en
I've marked all of these as done long ago. Please see: https://github.com/cncf/toc/issues/1021#issuecomment-1557453199
The only one that is not completely done is the OpenSSF Best Practices which we're working through. You can see the progress in the connected link above. And we don't have website analytics so nothing to do there.
Thanks for the update @blixtra.
I've updated the main checklist in the issue @Cmierly. Looks like the rest of the todo's are on the CNCF side.
FYI @RobertKielty on Snyk/FOSSA.
Hey @blixtra, what is the current status with the license scanning tool as FOSSA or Snyk? Anything we may help with?
cc @RobertKielty
@RobertKielty is this one set up for license scanning? Can we mark that complete? It's the last onboarding step 🚀
We had nothing on our todo list regarding license scanning. If there is something we need to do wrt FOSSA or Snyk please let us know what that is.
@RobertKielty may provide more details
I have DM'd @blixtra on CNCF Slack. Will update here when finished.
I have setup a Team on FOSSA and an new Organization on Snyk for Inspector Gagdet.
Next step is to send out invites. I have three recorded emails on the project that I can send invites to but both services are experiencing difficulties at the moment.
Ok, I've got an invite and signed up. Let us know what's next.
@blixtra I have added you to the Inspector Gagdet team on FOSSA
Import your project's repo into FOSSA.
FOSSA will scan the code for any licesne compliance issues. Let me know how you get on.
Hi @blixtra
I checked for imported repos and I couldn't see any associated with the team on CNCF FOSSA
Take a look at
https://docs.fossa.com/docs/quick-import
and import a project, let me know if you encounter any issues!
Thank you.