diff --git a/Justfile b/Justfile index fb0d8dbb..8f63a182 100644 --- a/Justfile +++ b/Justfile @@ -21,7 +21,7 @@ clean: rm -rf site # Serve docs site (unversioned, watches for changes) -serve: (_run "mkdocs serve -a 0.0.0.0:8000") +serve: (_run "mkdocs serve --strict -a 0.0.0.0:8000") # List published versions list: (_run "mike list -b publish") diff --git a/docs/install-upgrade/build-wiring.md b/docs/install-upgrade/build-wiring.md index 0f328335..56d69346 100644 --- a/docs/install-upgrade/build-wiring.md +++ b/docs/install-upgrade/build-wiring.md @@ -6,7 +6,7 @@ A wiring diagram is a YAML file that is a digital representation of your network. You can find more YAML level details in the User Guide section [switch features and port naming](../user-guide/profiles.md) and the -[api](../reference/api.md). It's mandatory for all switches to reference a +[api](../reference/fabric-api.md). It's mandatory for all switches to reference a `SwitchProfile` in the `spec.profile` of the `Switch` object. Only port naming defined by switch profiles could be used in the wiring diagram, NOS (or any other) port names aren't supported. An complete example wiring diagram is diff --git a/docs/install-upgrade/config.md b/docs/install-upgrade/config.md index 8d536f63..fb054d0f 100644 --- a/docs/install-upgrade/config.md +++ b/docs/install-upgrade/config.md @@ -31,7 +31,9 @@ After the above workflow a user will have a .img file suitable for installing th ## Complete Example File -The following example outlines a comprehensive Fabricator configuration. You can find further configuration details in the Fabricator [API Reference](../../reference/include-fab-api/). +The following example outlines a comprehensive Fabricator configuration. You +can find further configuration details in the Fabricator [API +Reference](../reference/fab-api.md). ``` { .yaml .annotate title="fab.yaml" linenums="1"} apiVersion: fabricator.githedgehog.com/v1beta1 diff --git a/docs/user-guide/shrink-expand.md b/docs/user-guide/shrink-expand.md index d2f20464..32c601b0 100644 --- a/docs/user-guide/shrink-expand.md +++ b/docs/user-guide/shrink-expand.md @@ -6,7 +6,7 @@ how to manage connections between them. Manipulating API objects is done with the assumption that target devices are correctly cabled and connected. This article uses terms that can be found in the [Hedgehog Concepts](../concepts/overview.md), the [User -Guide](overview.md) documentation, and the [Fabric API](../reference/api.md) reference. +Guide](overview.md) documentation, and the [Fabric API](../reference/fabric-api.md) reference. ### Add a switch to the existing fabric diff --git a/docs/vlab/running.md b/docs/vlab/running.md index e48c8f79..d66f5b54 100644 --- a/docs/vlab/running.md +++ b/docs/vlab/running.md @@ -399,7 +399,8 @@ about managing the Fabric in the [Running Demo](demo.md) and [User Guide](../use ### Getting main Fabric objects You can list the main Fabric objects by running `kubectl get` on the control node. You can find more details about -using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric API](../reference/api.md) and +using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric +API](../reference/fabric-api.md) and [Fabric CLI](../reference/cli.md) sections. For example, to get the list of switches, run: