cluster-api-provider-hetzner icon indicating copy to clipboard operation
cluster-api-provider-hetzner copied to clipboard

Published 20 hours ago • verified publisher icon syself

Better structure of CapH docs

Open Sayanta66 opened this issue 1 year ago • 5 comments

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

Sayanta66 avatar Jan 31 '24 04:01 Sayanta66

A rough idea of the structure:

  • Preparation doc should be in the Quickstart section
  • After preparation, the getting started doc should be there.
  • The ClusterAPI quickstart link shouldn't be in the quickstart section as a separate entity but be in somewhere in the getting started doc and that too in the prerequisite area.

Sayanta66 avatar Jan 31 '24 07:01 Sayanta66

@janiskemper Do you think this will be better?

Sayanta66 avatar Jan 31 '24 08:01 Sayanta66

sounds good!

janiskemper avatar Jan 31 '24 09:01 janiskemper

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 avatar Feb 07 '24 08:02 Sayanta66

  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

Sayanta66 avatar Feb 08 '24 07:02 Sayanta66

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

guettli avatar Aug 15 '24 13:08 guettli