Skip to content

Commit f7d962b

Browse files
authored
Use --strict for mkdocs build/deploy (#2157)
1 parent dff07d5 commit f7d962b

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Please follow this style to make the operator-controller project easier to revie
151151

152152
### Go version
153153

154-
Our goal is to minimize disruption by requiring the lowest possible Go language version. This means avoiding updaties to the go version specified in [go.mod](go.mod) (and other locations).
154+
Our goal is to minimize disruption by requiring the lowest possible Go language version. This means avoiding updaties to the go version specified in the project's `go.mod` file (and other locations).
155155
156156
There is a GitHub PR CI job named `go-verdiff` that will inform a PR author if the Go language version has been updated. It is not a required test, but failures should prompt authors and reviewers to have a discussion with the community about the Go language version change.
157157

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ VENVDIR := $(abspath docs/.venv)
477477
.PHONY: build-docs
478478
build-docs: venv
479479
. $(VENV)/activate; \
480-
mkdocs build
480+
mkdocs build --strict
481481

482482
.PHONY: serve-docs
483483
serve-docs: venv
@@ -487,7 +487,7 @@ serve-docs: venv
487487
.PHONY: deploy-docs
488488
deploy-docs: venv
489489
. $(VENV)/activate; \
490-
mkdocs gh-deploy --force
490+
mkdocs gh-deploy --force --strict
491491

492492
# The demo script requires to install asciinema with: brew install asciinema to run on mac os envs.
493493
# Please ensure that all demos are named with the demo name and the suffix -demo-script.sh

docs/draft/api-reference/catalogd-webserver-metas-endpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ As an example, to access only the [package schema](https://olm.operatorframework
3131

3232
the URL to access the service would be `https://catalogd-service.olmv1-system.svc/catalogs/operatorhubio/api/v1/metas?schema=olm.package`
3333

34-
For more examples of valid queries that can be made to the `api/v1/metas` service endpoint, please see [Catalog Queries](../howto/catalog-queries.md).
34+
For more examples of valid queries that can be made to the `api/v1/metas` service endpoint, please see [Catalog Queries](../../howto/catalog-queries.md).
3535

3636
!!! note
3737

docs/draft/howto/catalog-queries-metas-endpoint.md

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

3-
After you [add a catalog of extensions](../tutorials/add-catalog.md) to your cluster, you must port forward your catalog as a service.
3+
After you [add a catalog of extensions](../../tutorials/add-catalog.md) to your cluster, you must port forward your catalog as a service.
44
Then you can query the catalog by using `curl` commands and the `jq` CLI tool to find extensions to install.
55

66
## Prerequisites

docs/draft/tutorials/explore-available-content-metas-endpoint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hide:
55

66
# Explore Available Content
77

8-
After you [add a catalog of extensions](add-catalog.md) to your cluster, you must port forward your catalog as a service.
8+
After you [add a catalog of extensions](../../tutorials/add-catalog.md) to your cluster, you must port forward your catalog as a service.
99
Then you can query the catalog by using `curl` commands and the `jq` CLI tool to find extensions to install.
1010

1111
## Prerequisites
@@ -144,4 +144,4 @@ Then you can query the catalog by using `curl` commands and the `jq` CLI tool to
144144
145145
### Additional resources
146146
147-
* [Catalog queries](../howto/catalog-queries.md)
147+
* [Catalog queries](../../howto/catalog-queries.md)

0 commit comments

Comments
 (0)