toc
toc copied to clipboard
[SANDBOX PROJECT ONBOARDING] Devfile
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:
- [ ] Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.adoc#introduction
- [ ] 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
- [ ] Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
- [ ] Understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/
- [ ] Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
- [ ] 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
- [ ] Create maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to it
- [ ] Have added your project to https://github.com/cncf/contribute
- [ ] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
- [ ] 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
- [ ] 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
- [ ] GitHub: ensure that hat 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]
- [ ] CII: Start on a CII 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, welcome email has monthly project sync details
- [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
@l0rd - We'll be tracking onboarding in here, thanks!
cc @elsony @resios
Thank you @amye. We will work on that list in the coming days.
Excellent! One of the biggest helps for us is getting that maintainers file in (and getting me emails for you all!)
Created and migrated to the "devfile" slack channel (https://kubernetes.slack.com/archives/C02SX9E5B55) in the Kubernetes workspace.
DevStats page added.
@l0rd - checking in here, anything you need our help with?
@amye yes I have one question about maintainers: is there a limit on the number of maintainers? What does the maintainer role entail? How is it related to GitHub repositories privileges?
@amye yes I have one question about maintainers: is there a limit on the number of maintainers? What does the maintainer role entail? How is it related to GitHub repositories privileges?
So the projects can determine who their maintainers are and submit a PR to maintainers.cncf.io. For us, this limits who has access to the maintainers mailing list and Servicedesk.
@amye we are almost done with the maintainers list. We would also like to create a mailing list as a tool for our open governance and as the contact to put in the CoC. Can you create a mailing list for us in https://lists.cncf.io or should we create that outside of the CNCF?
@amye we are almost done with the maintainers list. We would also like to create a mailing list as a tool for our open governance and as the contact to put in the CoC. Can you create a mailing list for us in https://lists.cncf.io or should we create that outside of the CNCF?
"create a mailing list as a tool for our open governance and as the contact to put in the CoC" -- So I can create that for you, are you thinking that's an open list? (Because the CoC should probably not be.)
So I can create that for you
Thank you @amye
are you thinking that's an open list? (Because the CoC should probably not be.)
We need a mailing list mainly for the open governance, so yes I think it should be an open list. For the CoC it would be better a separate mailing list with the maintainers only. What do you think?
You can just use github discussions instead of a mailing list... mailing lists are optional imho
On Tue, Jan 25, 2022 at 11:52 AM Mario Loriedo @.***> wrote:
So I can create that for you
Thank you @amye https://github.com/amye
are you thinking that's an open list? (Because the CoC should probably not be.)
We need a mailing list mainly for the open governance, so yes I think it should be an open list. For the CoC it would be better a separate mailing list with the maintainers only. What do you think?
— Reply to this email directly, view it on GitHub https://github.com/cncf/toc/issues/773#issuecomment-1021454426, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAPSIJJ4ZJOQIVMQ5HXBRDUX3POBANCNFSM5LXAHEYQ . You are receiving this because you were assigned.Message ID: @.***>
-- Cheers,
Chris Aniszczyk https://aniszczyk.org
@caniszczyk makes sense for the "open governance". For the CoC contact what do you suggest?
Just point to the CNCF CoC :) https://github.com/cncf/foundation/blob/main/code-of-conduct.md
On Tue, Jan 25, 2022 at 12:23 PM Mario Loriedo @.***> wrote:
@caniszczyk https://github.com/caniszczyk makes sense for the "open governance". For the CoC contact what do you suggest?
— Reply to this email directly, view it on GitHub https://github.com/cncf/toc/issues/773#issuecomment-1021480526, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAPSIIIZJDV5I324UIDS7LUX3TDDANCNFSM5LXAHEYQ . You are receiving this because you were mentioned.Message ID: @.***>
-- Cheers,
Chris Aniszczyk https://aniszczyk.org
@amye Regarding "Website: Analytics transferred to [email protected]", can you clarify the requirement? Our website (landing page and docs) currently does not have the analytics set up but we do have telemetry enabled using Segment. Does it means there is no action required for our projects or does that covers telemtry as well? If it does, what is the action that we need to do?
- Is your project in its own separate neutral github organization?
Yes, it is. The org is: https://github.com/devfile
Hi @amye - just to confirm with regards to domain transfert: we need to provide the ownership (and IP) of the domain as well as the DNS configuration, is that correct?
- Could we have the domain pointing to our current nameservers to prevent any outage of the services accessible from the domain?
- For the website can we continue maintaining it and look to move it under Netlify once we are onboarded?
@amye the following tasks have been completed:
- 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 (DCO enabled)
- Submitted a Pull request to add your project as a sandbox project to landscape.cncf.io
@amye Regarding "Website: Analytics transferred to [email protected]", can you clarify the requirement? Our website (landing page and docs) currently does not have the analytics set up but we do have telemetry enabled using Segment. Does it mean there is no action required for our projects or does that cover telemetry as well? If it does, what is the action that we need to do?
@amye Can you confirm if there is any action needed for telemetry given that we currently doesn't has analytics set up?
@amye Regarding "Website: Analytics transferred to [email protected]", can you clarify the requirement? Our website (landing page and docs) currently does not have the analytics set up but we do have telemetry enabled using Segment. Does it mean there is no action required for our projects or does that cover telemetry as well? If it does, what is the action that we need to do?
@amye Can you confirm if there is any action needed for telemetry given that we currently doesn't has analytics set up?
You may want to review the telemetry policy, as I'm not familiar with Segment?
- Website: Analytics transferred to [email protected]
@amye After reviewing the telemetry policy and consulting with the LF legal team, our current telemetry in the devfile project meets the telemetry policy. Together with we currently don't have analytics set up on our website (https://github.com/cncf/toc/issues/773#issuecomment-1021632810), we have satisfied the requirement.
Hi @amye back to my previous question related to the domain transfert:
- Could we have the domain pointing to our current nameservers to prevent any outage of the services accessible from the domain? Do you have a point of contact we could be discussing about the best way to move forward on this area?
And for the website:
- can we continue maintaining (+running) it and look to move it under Netlify once we'll be onboarded?
I can see that Devfile's color icons (both png and svg) are just a small portion of the image area which makes them look rather bad as devstats icons, see here.
Hi @amye back to my previous question related to the domain transfert:
- Could we have the domain pointing to our current nameservers to prevent any outage of the services accessible from the domain? Do you have a point of contact we could be discussing about the best way to move forward on this area?
And for the website:
- can we continue maintaining (+running) it and look to move it under Netlify once we'll be onboarded?
This is likely a @nate-double-u / @idvoretskyi question!
I can see that Devfile's color icons (both png and svg) are just a small portion of the image area which makes them look rather bad as devstats icons, see here.
@lukaszgryglicki What is recommended size for that icon?
Hi @elsony ! My name is Crystal and I will be in charge of assisting sandbox projects with the onboarding process.
If you need help resizing your logo to look better as a devstats icon, you can submit a ticket to Creative Services asking for help in resizing Devfile's color icons.