[CORD-1924]
Documentation followup patch
Change-Id: I4387182ca58fa3fbb6ebda12f94f46e1a847e68f
diff --git a/docs/Makefile b/docs/Makefile
index df03d5b..892bae1 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,3 +1,10 @@
+# Makefile for building CORD docs site, guide.opencord.org
+# Building docs requires the following tools:
+# - Gitbook toolchain: https://toolchain.gitbook.com/setup.html
+# - NPM (for Gitbook and Swagger)
+# - Python (for build glossary script)
+# - linkchecker (for test target) http://wummel.github.io/linkchecker/
+
default: serve
# use bash for pushd/popd, and to fail if commands within a pipe fail
@@ -11,15 +18,20 @@
build: setup
gitbook build
-setup: clean platform-install test profiles xos xos-gui xos-tosca swagger $(GENERATED_DOCS)
+setup: clean platform-install cord-tester profiles xos xos-gui xos-tosca swagger $(GENERATED_DOCS)
gitbook init
gitbook install
+test: linkcheck
+
+linkcheck: build
+ linkchecker -a _book/
+
platform-install:
ln -s ../platform-install/docs platform-install
-test:
- ln -s ../../test/cord-tester/docs test
+cord-tester:
+ ln -s ../../test/cord-tester/docs cord-tester
profiles:
ln -s ../../orchestration/profiles profiles