cncf / toc

⚖️ The CNCF Technical Oversight Committee (TOC) is the technical governing body of the CNCF Foundation.
https://cncf.io
1.65k stars 628 forks source link

[SANDBOX PROJECT ONBOARDING] Xline #1093

Open amye opened 1 year ago

amye commented 1 year ago

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:

Things that the CNCF will do or help the project to do:

Phoenix500526 commented 1 year ago

The CNCF Code of Conduct is referenced in the project readme. FYI: https://github.com/datenlord/Xline#code-of-conduct

Phoenix500526 commented 1 year ago

emailed the maintainers' email addresses to project-onboarding@cncf.io

Phoenix500526 commented 1 year ago

DCO has installed for the Xline project

caniszczyk commented 1 year ago

@Phoenix500526 is there plans to move xline to a neutral github org? e.g. github.com/xline

Phoenix500526 commented 1 year ago

Regarding the following point, I have some questions:

GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership that we will onboard to our GitHub Enterprise instance: https://github.com/enterprises/cncf

In GitHub, the concept of "owner" exists only for organizations, while repositories have the concepts of "collaborators" and permissions. I have already invited caniszczyk and thelinuxfoundation as collaborators for the Xline repository and granted them admin permissions. But I feel like something might be wrong. Shall we create a new org called Xline and transfer the Xline repo to this org, and then add caniszczyk and thelinuxfoundation as owners of the Xline org? Thank you for your response.

Phoenix500526 commented 1 year ago

Yes @caniszczyk

Phoenix500526 commented 1 year ago

Are there any specific requirements for the org name? The name "xline" has already been taken. Can we use "xline.kv" as the org name instead? @amye @caniszczyk

amye commented 1 year ago

Are there any specific requirements for the org name? The name "xline" has already been taken. Can we use "xline.kv" as the org name instead? @amye @caniszczyk

You can do whatever makes sense for the project as long as it indicates that it's a separate organization.

Phoenix500526 commented 1 year ago

@caniszczyk Xline has been moved to a neutral GitHub org. FYI: https://github.com/xline-kv. DCO is on for all repos in the xline-kv.

lukaszgryglicki commented 1 year ago

DevStats instance added. Also added in All CNCF projects health instance. Will be fully-added to all other All CNCF dashboards on Friday (affiliations research started today, and will be imported as it progresses).

SandmanDZ commented 12 months ago

Hello @amye We are completing the onboarding checklist, and I have a couple of questions: 1. Xline does not have a slack channel, and we may not be able to migrate it to the Kubernetes or CNCF Slack. [Xline uses Discord instead] 2. Since Xline's official website is currently a static website and does not collect visitor information, we cannot transfer analytics such as PV/UV, etc. Then, what can we do at this point of time, any suggestions? Thank you~

amye commented 12 months ago

Discord + no analytics is fine

Phoenix500526 commented 11 months ago

The OpenSSF Best Practices Badge is added. FYI: https://github.com/xline-kv/Xline#readme @amye

SandmanDZ commented 11 months ago

@amye All items from the project side has been finished~~

amye commented 11 months ago

Can you confirm by checking off this list?

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.md#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/legal/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/ 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) Is your project in its own separate neutral github organization? 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 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:

Provide emails for the maintainers added to https://maintainers.cncf.io/ in order to get access to the maintainers mailing list and ServiceDesk - project-onboarding@cncf.io 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 that we will onboard to our GitHub Enterprise instance: https://github.com/enterprises/cncf 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 projects@cncf.io OpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en

Phoenix500526 commented 11 months ago

From the project side, please ensure that you:

Things that CNCF will need from the project:

Currently, 'caniszczyk' is added as the initial org owner. We have sent two invitations to 'thelinuxfoundation', but he has not accepted the invitations so far. Can we checkoff the item "GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners"? @amye

amye commented 9 months ago

Send another invite to 'thelinuxfoundation' and I'll see what I can do to pick that up!

Phoenix500526 commented 9 months ago

Send another invite to 'thelinuxfoundation' and I'll see what I can do to pick that up!

OK, I have sent the invitation.

RobertKielty commented 8 months ago

I created a FOSSA Team and a Snyk org for xline.

We next need to create a GitHub Profile associated with the maintainers email addr on Groups.io.

I posted a message to the maintainer list on groups.io to explain next steps.

Phoenix500526 commented 8 months ago

Execute me, does that mean we need to create a mail list on Groups.io? @RobertKielty

RobertKielty commented 7 months ago

Hi @Phoenix500526,

We can use the maintainers group for this, there's no need to make a new group.

Phoenix500526 commented 7 months ago

@RobertKielty Thanks for your reply. Excuse me, I accidentally forgot to accept the Snyk invitation you sent, and it has expired. Could you please resend it?

Cmierly commented 6 months ago

Hi @Phoenix500526 ! My name is Crystal and I'll now be in charge of assisting sandbox projects with the onboarding process! I'm checking in to see if you received a new invitation to Snyk?

Phoenix500526 commented 6 months ago

Hi @Cmierly ! I haven't received the new invitation to Snyk.

krook commented 6 months ago

Added to LFX Insights

Phoenix500526 commented 5 months ago

Execute me, do we need to add information to these LFX Insights? @krook

krook commented 5 months ago

@Phoenix500526 no, you don't need to add anything to it. It is enabled for your most popular repo, but you can let us know if you want to get reports on your secondary repos as well.

Through the left nav, you can go through the Overview, Velocity, and Productivity dashboards. There is also a set of info on Contributors, Organizations, and Activities under the Reports section.

You can find Insights documentation here, file tickets if something doesn't look right (v3 is in beta so any reports are very helpful), and post public feedback at this forum topic.

krook commented 1 month ago

@RobertKielty is this one set up for license scanning? Can we mark that complete?

RobertKielty commented 1 month ago

Xline FOSSA team is ready to be used. Email invites have been sent out to @Phoenix500526 @rogercloud @themanforfree @bsbds @iGxnon

Once accepted I will send add them to the team.

Then one of the maintainer will need to add their code repos to FOSSA for scanning.

Phoenix500526 commented 1 month ago

Hi, @RobertKielty. I have already accepted the invitation. I read the documentation and tried to import the Xline repo. However, I received a "Forbidden" error without any detailed explanation, as shown in the screenshot below: image

I have verified that the access permissions and policies are correctly set. But I don't know why FOSSA is forbidding me from importing this repo. Could you give me any suggestions? Thanks

RobertKielty commented 1 month ago

@Phoenix500526 thank you for setting this up.

Check that the email addresss associated with your FOSSA Account is the same as the one associated with your GitHub account.

The GitHub account that you used on FOSSA needs to have access to the repo being scanned.

If we need to we can log a support request with FOSSA but let's you and I go through it together first. DM me on Slack and I can take a look.

Phoenix500526 commented 1 month ago

@RobertKielty , thank you for your reply. I've DM you on Slack. 😁

Phoenix500526 commented 4 weeks ago

Hi, @RobertKielty! The license scanning is done. FYI: Xline FOSSA Report

RobertKielty commented 4 weeks ago

Hi @Phoenix500526 Can you DM me again please in the Cloud Native workspace on Slack?

I've accepted your invitation to join Xline Slack :) (We might need to talk about migrating you over to the Cloud Native Slack, I've created an xline channel there.)

For now though, let's collaborate on Xline Slack on FOSSA.

Phoenix500526 commented 3 weeks ago

OK, I wasn't aware that you had created an Xline channel on the Cloud Native Slack, so I created an Xline Slack. If needed, I can migrate to the Cloud Native Slack. Please tell me how to migrate. BTW, the FOSSA license scan report has been generated. Is there anything else I need to do? @RobertKielty

RobertKielty commented 3 weeks ago

I cannot see that the FOSSA scan you created scan was added to the Xline team that I created for the project in the CNCF FOSSA setup. I would prefer it if was tied to the team on CNCF FOSSA.

On Slack, yes we can work together export your current message history across to the Cloud Native workspace. There are advantages to setting up your Slack channels with us.

RobertKielty commented 2 weeks ago

@Phoenix500526 and I worked async on a Xline Slack DM between today and yesterday.

Yesterday, I added @Phoenix500526 as a Team Admin.

I note the addition of new team members by @Phoenix500526; we like it when project maintainers can self-administer the use of their service entitlements as CNCF Projects so thank you for doing that, that's perfect!

Then @Phoenix500526 added the main Xline repo https://github.com/xline-kv/Xline, to their FOSSA team.

The public version of the results of that Licsence Scan be found here.

https://app.fossa.com/reports/29af47d2-64b2-4763-ba88-174bf13a3f24

And I note the addition of the FOSSA Badge to the README on the main project. Nice.

The projects team name in FOSSA is now xline-kv. I changed it just now from Xline, so that it corresponds to the project's org name in GitHub sign-posting the way back to the GitHub from FOSSA.

There are other code repos in the xline-kv org, so I think they should also be added for License Scanning in FOSSA. @jeefy or @krook can you confirm any foundation rules as to what repos should be scanned and if or when there are exceptions to the license scanning requirement?

Thank you @Phoenix500526 for both your effort and patience on this onboarding task!