📖 Add a book for the Cluster API Operator

[Danil-Grigorev]

User Story

As a developer/user I would like to learn about CAPI operator features, designs and other CAPI operator guides, like installation, quickstart and day 2 operations, release procedures and more. Currently all information is stored inside a single markdown document, making it hard to read.

Detailed Description

CAPI uses a concept of a book - https://cluster-api.sigs.k8s.io/, CAPI operator should follow the same pattern.

Anything else you would like to add:

/kind feature

Tasks

Beta Give feedback

1. Implement book structure #330
   needs-triage +1
2. Implement publishing job
3. Separate existing documentation in individual chapters
4. Support serving multiple CAPI operator releases

[k8s-ci-robot]

This issue is currently awaiting triage.

If CAPI Operator contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[furkatgofurov7]

Thanks for issue (was postponing to open one 😄), I already started investigating it, so

/assign

[Danil-Grigorev]

I’ve separated this into sub-tasks, so anyone can help getting it done. Initial book implementation follows CAPI path, and is in #330. This will deploy book to the github pages.
Currently looking like this, should be a sufficient template to start:

[Danil-Grigorev]

cc @Fedosin @furkatgofurov7 @alexander-demicev

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[furkatgofurov7]

/remove-lifecycle stale

[furkatgofurov7]

Support serving multiple CAPI operator releases

@Danil-Grigorev I just found out that most of the CAPI providers if not all only have one version of their provider book and don't have versioned books per release branch as for example CAPI does. I can imagine that is because of maintenance work and as just simple as they did not have a need for it.

So my question would be: do we need really versioned books of CAPI operator hosted in Netlify as CAPI or not?

/cc @alexander-demicev @Fedosin @damdo @JoelSpeed if you folks have opinions, welcome!

[Danil-Grigorev]

@furkatgofurov7 I think for now we don't need multiple versions in our documentation, but we can return to this question in the future, if needed.