Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Standardization Initiative #307

Open
59 tasks
cloudymax opened this issue Nov 9, 2023 · 0 comments
Open
59 tasks

Documentation Standardization Initiative #307

cloudymax opened this issue Nov 9, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cloudymax
Copy link
Contributor

cloudymax commented Nov 9, 2023

Overview

In order to apply good standards to our docs we want to update the root README, Contributing, as well as the README for each app itself. This ticket will track our progress towards that goal.

We shall also create a Demo directory to show the proper structure.

Root README

  • ArgoCD
  • Cert-Manager
  • Coturn
  • External Secrets Operator
  • Harbor
  • Ingress-Nginx
  • k8up
  • Kubevirt
  • Kyverno
  • Mastodon
  • Mastodon-bitnami
  • Matrix
  • Metallb
  • Minio
  • Postgres
  • Prometheus
  • Test-app
  • Vouch Proxy
  • Zitadel

Update Apps

Argocd:

  • README
  • Screenshot

Cert-Manager:

  • README
  • Screenshot

Coturn:

  • README
  • Screenshot

External Secrets Operator:

  • README
  • Screenshot

Harbor:

  • README
  • Screenshot

Ingress-Nginx:

  • README
  • Screenshot

k8up:

  • README
  • Screenshot

Kubevirt:

  • README
  • Screenshot

Kyverno:

  • README
  • Screenshot

Mastodon:

  • README
  • Screenshot

Mastodon-Bitnami:

  • README
  • Screenshot

Matrix:

  • README
  • Screenshot

Metallb:

  • README
  • Screenshot

Minio:

  • README
  • Screenshot

Nextcloud:

  • README
  • Screenshot

Postgres:

  • README
  • Screenshot

Prometheus:

  • README
  • Screenshot

Test App:

  • README
  • Screenshot

Vouch Proxy:

  • README
  • Screenshot

Zitadel:

  • README
  • Screenshot
@cloudymax cloudymax added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 9, 2023
@jessebot jessebot changed the title Documentation Starndarization Initiative Documentation Standarization Initiative Nov 19, 2023
@jessebot jessebot changed the title Documentation Standarization Initiative Documentation Standardization Initiative Nov 19, 2023
@jessebot jessebot pinned this issue Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants