Update descriptions of GH repos

[dfarrell07]

The main description for each GitHub repository is created at the time of repo creation and then not paid much attention to, as it's not something most folks can edit or send PRs to change.

Some of the descriptions could use improvement, at least one is missing. It would be good to collect the current descriptions here, propose and agree on alternatives as a broader community, and then have an admin make the changes.

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[dfarrell07]

Reading through the repo descriptions again, I still think we should do this.

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[dfarrell07]

This might be a good thing to do during 0.12 Docs Day, as we will have Owner attention.

[dfarrell07]

Here are the current descriptions:

submariner
Connect all your Kubernetes clusters, no matter where they are in the world.

shipyard 
E2E testing framework and general scripts to create multiple K8s clusters with kind (K8s in Docker) for local E2E testing and development.

releases 
Submariner release process repository

submariner-website 
This is the submariner website source code (hugo based).

submariner-io.github.io 
Webpage static content (rendered from the 'website' repository)

submariner-operator 
Submariner's Operator installs and maintains your Submariner deployment.

submariner-charts

admiral 
Admiral is the submariner API to distribute and exchange metadata between clusters.

lighthouse 
Controller to facilitate DNS discovery between clusters

coastguard 
Controller to facilitate network policing on a multi-cluster connected environments (proof-of-concept state)

cloud-prepare 
Go library to prepare your cloud infrastructure via API for submariner to work on top

submariner-bot 
Our bot that automatically keeps branches for new PRs, etc..

enhancements 
This repository contains enhancement proposals for submariner-io projects

get.submariner.io 
Get submariner/subctl script

ovn-kubernetes 
Fork from ovn-kubernetes with the only purpose of temporarily keeping local changes on the kind deployment scripts. With the goal of contributing those as a more flexible and reusable bits to ovn-org.

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[tpantelis]

Some suggestions @sridhargaddam @skitt

submariner
Connect all your Kubernetes clusters, no matter where they are in the world.

This repository provides the networking layer to connect Pods and Services across Kubernetes clusters.

shipyard
E2E testing framework and general scripts to create multiple K8s clusters with kind (K8s in Docker) for local E2E testing and development.

This repository provides a framework and general scripts to create multiple K8s clusters with kind (K8s in Docker) for local E2E testing and development.

releases
Submariner release process repository

This repository contains the tooling to create Submariner product releases.

submariner-website
This is the submariner website source code (hugo based).

This repository contains the hugo-based source code for the Submariner website.

submariner-io.github.io
Webpage static content (rendered from the 'website' repository)

This repository provides the static web page content rendered from the 'submariner-website' repository.

submariner-operator
Submariner's Operator installs and maintains your Submariner deployment.

This repository provides the Operator that deploys the various Submariner components.

submariner-charts

This repository provides the source code to deploy the various Submariner components via Helm charts.

admiral
Admiral is the submariner API to distribute and exchange metadata between clusters.

This repository provides general, reusable APIs and code used by the various Submariner components.

lighthouse
Controller to facilitate DNS discovery between clusters

This repository provides DNS service discovery across connected Kubernetes clusters.

coastguard
Controller to facilitate network policing on a multi-cluster connected environments (proof-of-concept state)

This repository provides network policing across connected Kubernetes clusters.

cloud-prepare
Go library to prepare your cloud infrastructure via API for submariner to work on top

This repository provides APIs and code to prepare various cloud infrastructures for Submariner.

submariner-bot
Our bot that automatically keeps branches for new PRs, etc..

This repository contains a bot that maintains branches for in-progress PRs.

(unsure about this one)

enhancements
This repository contains enhancement proposals for submariner-io projects

Sounds good as is.

get.submariner.io
Get submariner/subctl script

This repository provides a script that retrieves the subctl binary for the desired version.

subctl
Submariner management tool (installation, diagnosis …)

This repository contains a CLI tool (subctl) that provides various commands to install, inspect and troubleshoot a Submariner deployment.

[dfarrell07]

@tpantelis Nice! What do you think about leaving off the "This repository..." part? I guess it's clear that the description applies to the repo it's associated with, and the descriptions should be quick to scan/read.

[dfarrell07]

submariner
Connect all your Kubernetes clusters, no matter where they are in the world.

This repository provides the networking layer to connect Pods and Services across Kubernetes clusters.

Networking layer to connect Pods and Services across Kubernetes clusters.

shipyard
E2E testing framework and general scripts to create multiple K8s clusters with kind (K8s in Docker) for local E2E testing and development.

This repository provides a framework and general scripts to create multiple K8s clusters with kind (K8s in Docker) for local E2E testing and development.

Framework and scripts to create multiple Kubernetes clusters with kind (K8s in Docker) for local E2E testing and development.

releases
Submariner release process repository

Tooling to create Submariner product releases.

Tooling to create Submariner releases.

submariner-website
This is the submariner website source code (hugo based).

This repository contains the hugo-based source code for the Submariner website.

Content and Hugo-based generation for the Submariner website.

submariner-io.github.io
Webpage static content (rendered from the 'website' repository)

This repository provides the static web page content rendered from the 'submariner-website' repository.

Static website rendered from the submariner-website repository.

submariner-operator
Submariner's Operator installs and maintains your Submariner deployment.

This repository provides the Operator that deploys the various Submariner components.

Operator that deploys the various Submariner components.

submariner-charts

This repository provides the source code to deploy the various Submariner components via Helm charts.

Helm charts to deploy the various Submariner components.

admiral
Admiral is the submariner API to distribute and exchange metadata between clusters.

This repository provides general, reusable APIs and code used by the various Submariner components.

General, reusable APIs and code used by the various Submariner components.

lighthouse
Controller to facilitate DNS discovery between clusters

This repository provides DNS service discovery across connected Kubernetes clusters.

DNS service discovery across connected Kubernetes clusters.

coastguard
Controller to facilitate network policing on a multi-cluster connected environments (proof-of-concept state)

This repository provides network policing across connected Kubernetes clusters.

Network policing across connected Kubernetes clusters.

cloud-prepare
Go library to prepare your cloud infrastructure via API for submariner to work on top

This repository provides APIs and code to prepare various cloud infrastructures for Submariner.

APIs and code to prepare various cloud infrastructures for Submariner.

submariner-bot
Our bot that automatically keeps branches for new PRs, etc..

This repository contains a bot that maintains branches for in-progress PRs.

(unsure about this one)

Bot that maintains branches for in-progress PRs.

enhancements
This repository contains enhancement proposals for submariner-io projects

Sounds good as is.

Enhancement proposals for Submariner projects.

get.submariner.io
Get submariner/subctl script

This repository provides a script that retrieves the subctl binary for the desired version.

Script that installs the subctl binary for the desired version.

subctl
Submariner management tool (installation, diagnosis …)

This repository contains a CLI tool (subctl) that provides various commands to install, inspect and troubleshoot a Submariner deployment.

CLI tool that provides helper commands to install, inspect, and troubleshoot a Submariner deployment.

[tpantelis]

I updated the projects.

[sridhargaddam]

Networking layer to connect Pods and Services across Kubernetes clusters.

Networking component for interconnecting Pods and Services across Kubernetes clusters.

Tooling to create Submariner releases.

Toolset for automating Submariner releases.

[dfarrell07]

Great, I think this is done. Thanks @tpantelis and @sridhargaddam!

[dfarrell07]

(of course if anyone else has suggestions for edits, feel free to re-open)