From 48a6ccf6c20c46d63f27bcda676f06640227bddf Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 19 Jun 2020 14:16:25 +0200 Subject: use w3c-linkchecker (not linkchecker: badly maintained in testing/unstable currently) --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index cd21f72..0137e88 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# Depends: myrepos git mkdocs linkchecker libtext-hogan-perl +# Depends: myrepos git mkdocs w3c-linkchecker libtext-hogan-perl domain ?= example.org shellhost ?= shell.$(domain) @@ -20,7 +20,7 @@ all: doc doc: docs $(patsubst %,docs/%,$(subst -,/,$(notdir $(wildcard source/*)))) mkdocs build - linkchecker site/index.html + checklink site/index.html docs: mkdir -p docs -- cgit v1.2.3 From ef054635fa74005a04e85eba4b7f478f64981d57 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 19 Jun 2020 15:37:31 +0200 Subject: add command: make check --- Makefile | 2 ++ SETUP.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 0137e88..9ef3a86 100644 --- a/Makefile +++ b/Makefile @@ -20,6 +20,8 @@ all: doc doc: docs $(patsubst %,docs/%,$(subst -,/,$(notdir $(wildcard source/*)))) mkdocs build + +check: checklink site/index.html docs: diff --git a/SETUP.md b/SETUP.md index 14e6c60..cd1492e 100644 --- a/SETUP.md +++ b/SETUP.md @@ -22,6 +22,11 @@ you additionally need `MKDocs` and some helper tools: sudo apt install make w3c-linkchecker libtext-hogan-perl mkdocs +For checking quality of generated website, +you need an extra helper tool: + + sudo apt install w3c-linkchecker + ## Fetch features @@ -49,6 +54,13 @@ This command generates a website from the feature texts: make +## Check website + +This command checks generated website for flaws in links: + + make check + + ## Cleanup All fetched and generated files can be removed -- cgit v1.2.3 From 2ef9ca8d05ec1ab9e511484413b04882fbd90233 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 19 Jun 2020 16:45:12 +0200 Subject: mark build target check as phony --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 9ef3a86..9e85e63 100644 --- a/Makefile +++ b/Makefile @@ -52,4 +52,4 @@ clean: distclean: clean rm -rf source -.PHONY: all doc clean distclean +.PHONY: all doc check clean distclean -- cgit v1.2.3 From 83b92e26072029241e181f11a66301a2f7f8650f Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 19 Jun 2020 18:50:11 +0200 Subject: fix process mustache for front README --- Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 9e85e63..3bd88cf 100644 --- a/Makefile +++ b/Makefile @@ -24,11 +24,11 @@ doc: docs $(patsubst %,docs/%,$(subst -,/,$(notdir $(wildcard source/*)))) check: checklink site/index.html +# TODO: drop symlink removal when 2020-06-19 is well in the past docs: mkdir -p docs - ln -sf ../README.md docs/index.md -# ln -sf ../USE.md docs/use.md -# ln -sf ../ADMIN.md docs/admin.md + find docs -type l -delete + $(MUSTACHE) < README.md > docs/index.md docs/%: source mkdir -p docs/$* -- cgit v1.2.3 From 8fe1e54f704d6a1eefff2109d578821cc0c52315 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Sat, 20 Jun 2020 10:42:22 +0200 Subject: include this SETUP as About → Website setup; Improve menu items below About MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 1 + mkdocs.yml | 8 +++++--- 2 files changed, 6 insertions(+), 3 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 3bd88cf..a6839fc 100644 --- a/Makefile +++ b/Makefile @@ -29,6 +29,7 @@ docs: mkdir -p docs find docs -type l -delete $(MUSTACHE) < README.md > docs/index.md + $(MUSTACHE) < SETUP.md > docs/setup.md docs/%: source mkdir -p docs/$* diff --git a/mkdocs.yml b/mkdocs.yml index 5653cde..baf9b19 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,8 @@ nav: # - Introduction: 'devel.md' - System: 'system/devel.md' - About: - - Structure: 'about/index.md' - - 'Technical setup': 'about/setup.md' - - 'Maintenance': 'about/admin.md' + - Website: 'index.md' + - 'Website setup': 'setup.md' + - 'Source structure': 'about/index.md' + - 'Source setup': 'about/setup.md' + - 'Source maintenance': 'about/admin.md' -- cgit v1.2.3