guidelines/Makefile

mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
mkfile_dir := $(patsubst %/,%,$(dir $(mkfile_path)))
docsbuilder := $(abspath $(mkfile_dir)/docsbuilder.sh)

doc:
	$(docsbuilder) -b

build:	doc

.ONESHELL:
serve: 
	$(info *** Make sure to refresh pages without cache ***)
	$(docsbuilder) -p

watch:
	$(docsbuilder) -a

linkcheck:
	$(docsbuilder) -k
	$(docsbuilder) -p
	linkchecker http://localhost:8080 --check-extern --no-robots \
		--ignore-url "drupal.org" \
		--ignore-url "file:///antora" \
		--ignore-url 'http://localhost:8080/en-US'
	$(docsbuilder) -k

.DEFAULT_GOAL := doc
.PHONY: doc linkcheck serve watch
Makefile: trivial improvements Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-23 20:53:46 +02:00			`mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))`
			`mkfile_dir := $(patsubst %/,%,$(dir $(mkfile_path)))`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`docsbuilder := $(abspath $(mkfile_dir)/docsbuilder.sh)`
adapt to antora Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-21 14:28:51 +02:00
Makefile: trivial improvements Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-23 20:53:46 +02:00			`doc:`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`$(docsbuilder) -b`

			`build: doc`
adapt to antora Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-21 14:28:51 +02:00
Makefile: don't use python3.7 feature Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-10-02 17:25:32 +02:00			`.ONESHELL:`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`serve:`
Makefile: trivial improvements Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-23 20:53:46 +02:00			`$(info * Make sure to refresh pages without cache *)`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`$(docsbuilder) -p`

			`watch:`
			`$(docsbuilder) -a`
adapt to antora Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-21 14:28:51 +02:00
Add a linkcheck Makefile target drupal.org is ignored because it detects automated browsing and complains. 2021-10-06 15:50:04 -05:00			`linkcheck:`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`$(docsbuilder) -k`
			`$(docsbuilder) -p`
linkchecker doesn't support --complete argument 2025-11-19 18:35:04 -05:00			`linkchecker http://localhost:8080 --check-extern --no-robots \`
linkchecker: Add ignores for housekeeping links The Antora server will include a language-switching link and an edit link for each file, both of which aren't valid in the preview and need to be ignored. The edit link takes the form `file:///antora/...`, a path that's only valid inside the container. The language link points from every document `https://localhost:8080/guidelines/foo` to a language-specific URL like `https://localhost:8080/en-US/guidelines/foo` The latter may need to be tweaked if they're dependent on the system locale of the user running linkchecker. Ignoring `https://localhost:8080/en-US` works for me, but may not be universal. 2025-11-19 19:00:42 -05:00			`--ignore-url "drupal.org" \`
			`--ignore-url "file:///antora" \`
			`--ignore-url 'http://localhost:8080/en-US'`
Shut down server after running linkchecker 2025-11-19 18:55:17 -05:00			`$(docsbuilder) -k`
Add a linkcheck Makefile target drupal.org is ignored because it detects automated browsing and complains. 2021-10-06 15:50:04 -05:00
adapt to antora Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org> 2018-09-21 14:28:51 +02:00			`.DEFAULT_GOAL := doc`
Repo tooling: Adopt the docsbuilder.sh script Instead of using podman commands directly in the Makefile, add the `docsbuilder.sh` script from the [docs templates repo][1]. Rewrite the Makefile to use docsbuilder commands to perform its functions. Changes: - The preview URL changes from `https://localhost:8000` to `https://localhost:8080/` - `build` is now a synonym for `doc` - `serve` now runs `docsbuilder -p` which automatically rebuilds the doc first - `watch` is now available to start a server that automatically rebuilds the preview on file changes - `linkcheck` will automatically start a preview server before running `linkchecker` [1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template 2025-11-15 23:39:10 -05:00			`.PHONY: doc linkcheck serve watch`