cncf / techdocs

CNCF TechDocs Team
https://www.cncf.io
Apache License 2.0
37 stars 26 forks source link

Ensure 100% of CNCF projects have a site - 2024Q2 #196

Open nate-double-u opened 8 months ago

nate-double-u commented 8 months ago

To start, let's find out how many sites actually have no website.

For a first pass let's look at CLOMonitor: CNCF projects with no site listed to generate a list of projects to check. Some CLOMonitor entries report no website even if there is a site -- this is an artifact of how CLOMonitor checks. When we find projects that are mis-reported, we should open an issue with the project to make the update to correct the CLOMonitor report.

Once we get a better list of sites that really don't have a website, we can build a list of projects to reach out to.

Follows up on:

Project (CLOMonitor link) Has website CLOMonitor says it has a website github org/repo repo lists URL upstream issue/comment Note
Carvel carvel.dev carvel-dev/carvel https://github.com/cncf/clomonitor/pull/1392 Fixed
Confidential Containers confidential-containers
Contour projectcontour.io projectcontour/community https://github.com/projectcontour/community/issues/41 Fixed
Emissary-Ingress https://www.getambassador.io/docs/emissary emissary-ingress/community https://github.com/emissary-ingress/community/issues/10 Fixed
Konveyor konveyor.io konveyor/community https://github.com/konveyor/community/issues/72 Fixed
Krator docs.rs/crate/krator krator-rs/krator https://github.com/krator-rs/krator/issues/75 This project does not have an actual website.
KubeClipper kubeclipper.io kubeclipper/community https://github.com/kubeclipper/community/issues/9
KubeEdge kubeedge.io kubeedge/community https://github.com/kubeedge/community/issues/191 Fixed
Kubeflow kubeflow.org kubeflow/community https://github.com/kubeflow/community/issues/681
Kuberhealthy kuberhealthy/kuberhealthy https://github.com/kuberhealthy/kuberhealthy/issues/1176
kube-vip kube-vip.io kube-vip/kube-vip https://github.com/kube-vip/kube-vip/issues/701 Fixed
KubeVirt kubevirt.io kubevirt/community https://github.com/kubevirt/community/issues/253
Notary notaryproject.dev notaryproject/notary https://github.com/notaryproject/notary/issues/1697 Fixed
OpenGitOps opengitops.dev open-gitops/project https://github.com/open-gitops/project/issues/171
Opreator Framework operatorframework.io operator-framework/community https://github.com/operator-framework/community/issues/101
ORAS oras.land oras-project/community https://github.com/oras-project/community/issues/57 Fixed
PARSEC parsec.community parallaxsecond/community https://github.com/parallaxsecond/community/issues/124 Fixed
Piraeus piraeus.io piraeusdatastore/piraeus https://github.com/piraeusdatastore/piraeus/issues/166 Fixed
sealer sealer.cool sealerio/community https://github.com/sealerio/community/issues/9
SOPS getsops.io getsops/sops https://github.com/getsops/sops/issues/1395 Fixed
Submariner submariner.io submariner-io/submariner https://github.com/submariner-io/submariner/issues/2858 Fixed
Volcano volcano.sh volcano-sh/community https://github.com/volcano-sh/community/issues/47

* CLOMonitor Website check info

nate-double-u commented 7 months ago

@tegioz, there are a couple sites on this list that should probably pass the CLOMonitor test -- carvel & projectcontour -- are they listing their sites in the wrong spot in their github org?

The CLOMonitor Website Check just says "a website url is configured in the Github repository," which I think may not be precisely correct.

tegioz commented 7 months ago

Hi @nate-double-u 👋

The website check is part of the community check set, so it's run on the repository that has that check set assigned. This check verifies that a website url is listed on that repository, as described in the docs:

ah

Contour

If you go to the Contour's CLOMonitor page, you'll see that the repository with the community check set is https://github.com/projectcontour/community. But that repository doesn't have a website configured yet.

contour

Carvel

This one is more interesting 😉 In the Carvel's CLOMonitor page, the repository with the community check set is https://github.com/vmware-tanzu/carvel. If you visit that url in your browser, you'll notice that you'll be redirected to https://github.com/carvel-dev/carvel. However, and this could a GitHub problem, when we try to collect information from vmware-tanzu/carvel using the GitHub API from CLOMonitor, we get redirected to carvel-dev/carvel-community instead of to the correct one. My guess is that they renamed the repository twice, and somehow this got the redirection on the API side confused, but not sure. Anyway, the community repository listed in CLOMonitor isn't correct anyway, so the solution would be to update it in the data file. As soon as that's done and CLOMonitor checks that repository again the website check should pass.

Hope this helps!