Skip to content

Commit 9d950e6

Browse files
Refactor core developer guide
1 parent c1c8833 commit 9d950e6

33 files changed

+225
-194
lines changed

docs/book/src/SUMMARY.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -67,35 +67,36 @@
6767
- [clusterctl Provider Contract](clusterctl/provider-contract.md)
6868
- [clusterctl for Developers](clusterctl/developers.md)
6969
- [clusterctl Extensions with Plugins](clusterctl/plugins.md)
70-
- [Developer Guide](./developer/guide.md)
71-
- [Repository Layout](./developer/repository-layout.md)
72-
- [Rapid iterative development with Tilt](./developer/tilt.md)
73-
- [Logging](./developer/logging.md)
74-
- [Testing](./developer/testing.md)
75-
- [Developing E2E tests](./developer/e2e.md)
76-
- [Controllers](./developer/architecture/controllers.md)
77-
- [Bootstrap](./developer/architecture/controllers/bootstrap.md)
78-
- [Cluster](./developer/architecture/controllers/cluster.md)
79-
- [Machine](./developer/architecture/controllers/machine.md)
80-
- [MachineSet](./developer/architecture/controllers/machine-set.md)
81-
- [MachineDeployment](./developer/architecture/controllers/machine-deployment.md)
82-
- [MachineHealthCheck](./developer/architecture/controllers/machine-health-check.md)
83-
- [Control Plane](./developer/architecture/controllers/control-plane.md)
84-
- [MachinePool](./developer/architecture/controllers/machine-pool.md)
85-
- [ClusterTopology](./developer/architecture/controllers/cluster-topology.md)
86-
- [ClusterResourceSet](./developer/architecture/controllers/cluster-resource-set.md)
87-
- [Multi-tenancy](./developer/architecture/controllers/multi-tenancy.md)
88-
- [Support multiple instances](./developer/architecture/controllers/support-multiple-instances.md)
89-
- [Tuning controllers](./developer/architecture/controllers/tuning.md)
70+
- [Developer Guide](./developer/getting-started.md)
71+
- [Developing "core" Cluster API](developer/core/overview.md)
72+
- [Rapid iterative development with Tilt](developer/core/tilt.md)
73+
- [Repository Layout](developer/core/repository-layout.md)
74+
- [Controllers](./developer/core/controllers/overview.md)
75+
- [Cluster](./developer/core/controllers/cluster.md)
76+
- [ClusterTopology](./developer/core/controllers/cluster-topology.md)
77+
- [ClusterResourceSet](./developer/core/controllers/cluster-resource-set.md)
78+
- [MachineDeployment](./developer/core/controllers/machine-deployment.md)
79+
- [MachineSet](./developer/core/controllers/machine-set.md)
80+
- [Machine](./developer/core/controllers/machine.md)
81+
- [MachinePool](./developer/core/controllers/machine-pool.md)
82+
- [MachineHealthCheck](./developer/core/controllers/machine-health-check.md)
83+
- [Bootstrap](./developer/core/controllers/bootstrap.md)
84+
- [Control Plane](./developer/core/controllers/control-plane.md)
85+
- [Logging](developer/core/logging.md)
86+
- [Testing](developer/core/testing.md)
87+
- [Developing E2E tests](developer/core/e2e.md)
88+
- [Tuning controllers](./developer/core/tuning.md)
89+
- [Support multiple instances](./developer/core/support-multiple-instances.md)
90+
- [Multi-tenancy](./developer/core/multi-tenancy.md)
9091
- [Developing providers](./developer/providers/overview.md)
9192
- [Getting started](developer/providers/getting-started/overview.md)
92-
- [Naming](developer/providers/getting-started/naming.md)
93-
- [Initialize Repo and API types](developer/providers/getting-started/initialize-repo-and-api-types.md)
94-
- [Implement API types](developer/providers/getting-started/implement-api-types.md)
95-
- [Webhooks](developer/providers/getting-started/webhooks.md)
96-
- [Controllers and Reconciliation](developer/providers/getting-started/controllers-and-reconciliation.md)
97-
- [Configure the provider manifest](developer/providers/getting-started/configure-the-deployment.md)
98-
- [Building, Running, Testing](developer/providers/getting-started/building-running-and-testing.md)
93+
- [Naming](developer/providers/getting-started/naming.md)
94+
- [Initialize Repo and API types](developer/providers/getting-started/initialize-repo-and-api-types.md)
95+
- [Implement API types](developer/providers/getting-started/implement-api-types.md)
96+
- [Webhooks](developer/providers/getting-started/webhooks.md)
97+
- [Controllers and Reconciliation](developer/providers/getting-started/controllers-and-reconciliation.md)
98+
- [Configure the provider manifest](developer/providers/getting-started/configure-the-deployment.md)
99+
- [Building, Running, Testing](developer/providers/getting-started/building-running-and-testing.md)
99100
- [Provider contracts](./developer/providers/contracts.md)
100101
- [Cluster Infrastructure](./developer/providers/cluster-infrastructure.md)
101102
- [Control Plane](./developer/providers/control-plane.md)

docs/book/src/clusterctl/provider-contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ While defining the Deployment Spec, the container that executes the controller/r
254254

255255
For controllers only, the manager MUST support a `--namespace` flag for specifying the namespace where the controller
256256
will look for objects to reconcile; however, clusterctl will always install providers watching for all namespaces
257-
(`--namespace=""`); for more details see [support for multiple instances](../developer/architecture/controllers/support-multiple-instances.md)
257+
(`--namespace=""`); for more details see [support for multiple instances](../developer/core/support-multiple-instances.md)
258258
for more context.
259259

260260
While defining Pods for Deployments, canonical names should be used for images.

docs/book/src/developer/architecture/controllers.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/book/src/developer/architecture/controllers/machine-deployment.md renamed to docs/book/src/developer/core/controllers/machine-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MachineDeployment
22

3-
A MachineDeployment orchestrates deployments over a fleet of [MachineSets](./machine-set.md).
3+
A MachineDeployment orchestrates deployments over a fleet of MachineSets.
44

55
Its main responsibilities are:
66
* Adopting matching MachineSets not assigned to a MachineDeployment

docs/book/src/developer/architecture/controllers/machine-health-check.md renamed to docs/book/src/developer/core/controllers/machine-health-check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MachineHealthCheck
22

3-
A MachineHealthCheck is responsible for remediating unhealthy [Machines](./machine.md).
3+
A MachineHealthCheck is responsible for remediating unhealthy Machines.
44

55
Its main responsibilities are:
66
* Checking the health of Nodes in the [workload clusters] against a list of unhealthy conditions

0 commit comments

Comments
 (0)