small-hack/argocd-apps
small-hack/argocd-apps
2
1
Fork 0
Code Issues 14 Pull requests Projects Releases Packages Wiki Activity Actions

Documentation Standardization Initiative #307

New issue
Open
opened 2023-11-09 12:21:22 +00:00 by cloudymax · 0 comments
cloudymax commented 2023-11-09 12:21:22 +00:00 (Migrated from github.com)
Copy link

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
# 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
👍 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
harbor-refresh
cloudymax-patch-1
forgejo-federation
renovate/tempo-distributed-1.x
renovate/postgresql-18.x
renovate/argo-cd-9.x
renovate/kubevirt-vm-0.x
renovate/hashicorp-vault-1.x
renovate/openbao-0.x
renovate/nextcloud-8.x
finish-juicefs
renovate/kubevirt-stack-0.x
temporary-storage-class-fix
swfs-kubevirt
no-smtp-env-vars
new-loki
forgejo-testing
renovate/https-github.com-metallb-metallb.git-0.x
environment-promotion-idea
valkey-nextcloud
renovate/registry-1.docker.io-bitnamicharts-valkey-2.x
simple
renovate/seaweedfs-4.x
grafana-login-enabled
no-smtp-zitadel
try-wrenix-pr-480
add-rss-bot
disable-modsecurity
testing-haproxy
routhinator-may-2-suggestion
bradley
feat/workflows
fix/home-assistant-proxy
feat/ingress-metrics-enabled
argo-multi-source-issue
max-testing
add-nvidia-apps
old-secrets-for-peertube
before-hookshot-removal
nextclouud-s3-as-primary-object-store
before-eso-helm-chart-test-merge
before-nextcloud-cron-removal
maxs-old-bweso
Labels
Clear labels   
WAF

something to do with our WAF

  
blocked

unable to move forward at this time

  
bug

Something isn't working

  
ci/cd

antyhing to do with continous integration/deployment including renovatebot

  
documentation

Improvements or additions to documentation

  
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
good first issue

Good for newcomers

  
help wanted

Extra attention is needed

  
ingress

   
invalid

This doesn't seem right

  
monitoring

   
question

Further information is requested

  
security

   
wontfix

This will not be worked on

  
😭 email

anything to do with SMTP or email generally

No labels
WAF
blocked
bug
ci/cd
documentation
duplicate
enhancement
good first issue
help wanted
ingress
invalid
monitoring
question
security
wontfix
😭 email
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
small-hack/argocd-apps#307
No description provided.