rancher-sandbox / cluster-api-addon-provider-fleet

Cluster API Add-on Provider for Fleet will auto register child clusters with https://fleet.rancher.io/.

Apache License 2.0

2 stars 3 forks source link

docs: add book structure and basic documentation #51

Closed salasberryfin closed 4 months ago

salasberryfin commented 4 months ago

Description

This PR adds basic documentation on how to install the provider. The docs are structured to support the creation of a book in line with most upstream CAPI projects (for example CAPG).

The documentation is a work in progress and this PR is only a basic scaffolding to build a more complete reference on top of it.

Danil-Grigorev commented 4 months ago

I think this should cover #20 as well, thanks Carlos for working on it, LGTM

salasberryfin commented 4 months ago

Thanks for the review @Danil-Grigorev. I updated the PR with a reference to just in the prerequisites section + updated the content of the docs/README.md including the existing information from the project's README file + some extra references to internal documentation.