Skip to content

Commit eab0e88

Browse files
committed
🏃 Add more items to book's structure
Signed-off-by: Vince Prignano <[email protected]>
1 parent ca112ae commit eab0e88

File tree

8 files changed

+15
-11
lines changed

8 files changed

+15
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Scope, objectives, goals and requirements](./docs/scope-and-objectives.md)
1313
- [Feature proposals](./docs/proposals)
1414
- [Reference use cases](./docs/staging-use-cases.md)
15-
- [Quick Start](https://cluster-api.sigs.k8s.io/quick-start.html)
15+
- [Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html)
1616

1717
## What is the Cluster API?
1818

docs/book/src/SUMMARY.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
[Introduction](./introduction.md)
44

5-
[Quick Start](./quick-start.md)
5+
- [User Guide](./user/guide.md)
6+
- [Concepts](./user/concepts.md)
7+
- [Quick Start](./user/quick-start.md)
68

7-
- [Architecture](./architecture/architecture.md)
9+
- [Developer Guide](./architecture/architecture.md)
810
- [Repository Layout](./architecture/repository-layout.md)
911
- [Controllers](./architecture/controllers.md)
1012
- [Cluster](./architecture/controllers/cluster.md)
1113
- [Machine](./architecture/controllers/machine.md)
1214
- [MachineSet](./architecture/controllers/machine-set.md)
1315
- [MachineDeployment](./architecture/controllers/machine-deployment.md)
14-
15-
- [Clusterctl](./clusterctl/clusterctl.md)
16-
17-
- [Provider Implementers](./providers/implementers.md)
16+
- [Provider Implementers](./providers/implementers.md)
17+
- [v1alpha1 to v1alpha2](./providers/v1alpha1-to-v1alpha2.md)
18+
- [Tooling](./tooling/tooling.md)
19+
- [Clusterctl](./tooling/clusterctl.md)
1820

1921
- [Reference](./reference/reference.md)
2022
- [Abbreviations](./reference/abbreviations.md)

docs/developer/v1alpha1-compared-to-v1alpha2.md renamed to docs/book/src/providers/v1alpha1-to-v1alpha2.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ controllers that are responsible for the core types:
2525
* Machine
2626
* MachineSet
2727
* MachineDeployment
28-
* [plus a few more](../../pkg/apis/cluster/v1alpha2)
2928

3029
Bootstrap providers are an entirely new concept aimed at reducing the amount of kubeadm boilerplate that every provider
3130
reimplemented in v1alpha1. The Bootstrap provider is responsible for running a controller that generates data necessary
@@ -41,7 +40,7 @@ bootstrap data to turn the infrastructure into a Kubernetes cluster.
4140

4241
Actuators are interfaces that the Cluster API controller calls. A provider pulls in the generic Cluster API controller
4342
and then registers actuators to run specific infrastructure logic (calls to the provider cloud).
44-
43+
4544
### v1alpha2
4645

4746
Actuators are not used in this version. Cluster API's controllers are no longer shared across providers and therefore
@@ -57,11 +56,11 @@ create a cloud instance for Kubernetes to run on.
5756

5857
`clusterctl` was a command line tool packaged with v1alpha1 providers. The goal of this tool was to go from nothing to a
5958
running management cluster in whatever environment the provider was built for. For example, Cluster-API-Provider-AWS
60-
packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to
59+
packaged a `clusterctl` that created a Kubernetes cluster in EC2 and installed the necessary controllers to respond to
6160
Cluster API's APIs.
6261

6362
### v1alpha2
6463

65-
`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused
64+
`clusterctl` is likely becoming provider-agnostic meaning one clusterctl is bundled with Cluster API and can be reused
6665
across providers. Work here is still being figured out but providers will not be packaging their own `clusterctl`
6766
anymore.
File renamed without changes.

docs/book/src/tooling/tooling.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Tooling

docs/book/src/user/concepts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Concepts

docs/book/src/user/guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# User Guide
File renamed without changes.

0 commit comments

Comments
 (0)