toc icon indicating copy to clipboard operation
toc copied to clipboard

[SANDBOX PROJECT ONBOARDING] Devfile

Open amye opened this issue 3 years ago • 28 comments

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:

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:

amye avatar Jan 11 '22 18:01 amye

@l0rd - We'll be tracking onboarding in here, thanks!

amye avatar Jan 12 '22 16:01 amye

cc @elsony @resios

l0rd avatar Jan 12 '22 17:01 l0rd

Thank you @amye. We will work on that list in the coming days.

l0rd avatar Jan 12 '22 17:01 l0rd

Excellent! One of the biggest helps for us is getting that maintainers file in (and getting me emails for you all!)

amye avatar Jan 12 '22 18:01 amye

Created and migrated to the "devfile" slack channel (https://kubernetes.slack.com/archives/C02SX9E5B55) in the Kubernetes workspace.

elsony avatar Jan 18 '22 20:01 elsony

DevStats page added.

lukaszgryglicki avatar Jan 19 '22 06:01 lukaszgryglicki

@l0rd - checking in here, anything you need our help with?

amye avatar Jan 20 '22 19:01 amye

@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?

l0rd avatar Jan 24 '22 17:01 l0rd

@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 avatar Jan 24 '22 17:01 amye

@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?

l0rd avatar Jan 25 '22 15:01 l0rd

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

amye avatar Jan 25 '22 17:01 amye

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?

l0rd avatar Jan 25 '22 17:01 l0rd

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 avatar Jan 25 '22 17:01 caniszczyk

@caniszczyk makes sense for the "open governance". For the CoC contact what do you suggest?

l0rd avatar Jan 25 '22 18:01 l0rd

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

caniszczyk avatar Jan 25 '22 18:01 caniszczyk

@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?

elsony avatar Jan 25 '22 21:01 elsony

  • Is your project in its own separate neutral github organization?

Yes, it is. The org is: https://github.com/devfile

elsony avatar Jan 26 '22 21:01 elsony

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?

slemeur avatar Jan 27 '22 10:01 slemeur

@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

l0rd avatar Feb 01 '22 09:02 l0rd

@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?

elsony avatar Feb 07 '22 20:02 elsony

@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?

amye avatar Feb 07 '22 20:02 amye

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

elsony avatar Feb 10 '22 19:02 elsony

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?

slemeur avatar Feb 15 '22 16:02 slemeur

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 avatar Feb 15 '22 16:02 lukaszgryglicki

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!

amye avatar Feb 15 '22 16:02 amye

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?

elsony avatar Feb 16 '22 22:02 elsony

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.

Cmierly avatar Dec 15 '23 00:12 Cmierly