syself / cluster-api-provider-hetzner

Cluster API Provider Hetzner :rocket: The best way to manage Kubernetes clusters on Hetzner, fully declarative, Kubernetes-native and with self-healing capabilities
https://caph.syself.com
Apache License 2.0
586 stars 56 forks source link

Better structure of CapH docs #1124

Closed Sayanta66 closed 6 days ago

Sayanta66 commented 6 months ago

This issue indicates a better structure of the CapH docs in terms of indexing. The following ideas can be seen below:

Sayanta66 commented 6 months ago

A rough idea of the structure:

Sayanta66 commented 6 months ago

@janiskemper Do you think this will be better?

janiskemper commented 6 months ago

sounds good!

Sayanta66 commented 6 months ago

Reference links - https://cluster-api.sigs.k8s.io/reference/api_reference https://doc.crds.dev/github.com/syself/cluster-api-provider-hetzner https://cluster-api.sigs.k8s.io/developer/guide

Sayanta66 commented 6 months ago
  1. Introduction
  2. Preparation
  3. Quickstart
  4. CAPH Topics 4.1. Managing SSH Keys 4.1.1. Hetzner Cloud 4.1.2. Hetzner Robot 4.2. Node Images
  5. Guides 5.1. Hetzner Dedicated / Baremetal server
  6. Developer Guide
  7. Troubleshooting
  8. Reference
guettli commented 6 days ago

I think this is implemented now: https://syself.com/docs/caph/getting-started/introduction