Skip to content

Commit 0018928

Browse files
authored
docs: enable strict mode for broken link checking (#123)
Signed-off-by: Logan Blyth <[email protected]>
1 parent f89a803 commit 0018928

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

Justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ clean:
2121
rm -rf site
2222

2323
# Serve docs site (unversioned, watches for changes)
24-
serve: (_run "mkdocs serve -a 0.0.0.0:8000")
24+
serve: (_run "mkdocs serve --strict -a 0.0.0.0:8000")
2525

2626
# List published versions
2727
list: (_run "mike list -b publish")

docs/install-upgrade/build-wiring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
A wiring diagram is a YAML file that is a digital representation of your
77
network. You can find more YAML level details in the User Guide section [switch
88
features and port naming](../user-guide/profiles.md) and the
9-
[api](../reference/api.md). It's mandatory for all switches to reference a
9+
[api](../reference/fabric-api.md). It's mandatory for all switches to reference a
1010
`SwitchProfile` in the `spec.profile` of the `Switch` object. Only port naming
1111
defined by switch profiles could be used in the wiring diagram, NOS (or any
1212
other) port names aren't supported. An complete example wiring diagram is

docs/install-upgrade/config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ After the above workflow a user will have a .img file suitable for installing th
3131

3232
## Complete Example File
3333

34-
The following example outlines a comprehensive Fabricator configuration. You can find further configuration details in the Fabricator [API Reference](../../reference/include-fab-api/).
34+
The following example outlines a comprehensive Fabricator configuration. You
35+
can find further configuration details in the Fabricator [API
36+
Reference](../reference/fab-api.md).
3537

3638
``` { .yaml .annotate title="fab.yaml" linenums="1"}
3739
apiVersion: fabricator.githedgehog.com/v1beta1

docs/user-guide/shrink-expand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ how to manage connections between them.
66
Manipulating API objects is done with the assumption that target devices are correctly cabled and connected.
77

88
This article uses terms that can be found in the [Hedgehog Concepts](../concepts/overview.md), the [User
9-
Guide](overview.md) documentation, and the [Fabric API](../reference/api.md) reference.
9+
Guide](overview.md) documentation, and the [Fabric API](../reference/fabric-api.md) reference.
1010

1111
### Add a switch to the existing fabric
1212

docs/vlab/running.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,8 @@ about managing the Fabric in the [Running Demo](demo.md) and [User Guide](../use
399399
### Getting main Fabric objects
400400

401401
You can list the main Fabric objects by running `kubectl get` on the control node. You can find more details about
402-
using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric API](../reference/api.md) and
402+
using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric
403+
API](../reference/fabric-api.md) and
403404
[Fabric CLI](../reference/cli.md) sections.
404405

405406
For example, to get the list of switches, run:

0 commit comments

Comments
 (0)