blob: 2eebb04559609b7e1c7ddb65b4b2446a24fba36f [file] [log] [blame]
Zack Williams144027f2017-09-25 18:01:47 -07001# Makefile for building CORD docs site, guide.opencord.org
2# Building docs requires the following tools:
3# - Gitbook toolchain: https://toolchain.gitbook.com/setup.html
4# - NPM (for Gitbook and Swagger)
5# - Python (for build glossary script)
6# - linkchecker (for test target) http://wummel.github.io/linkchecker/
7
Zack Williams1b96a952017-07-17 16:48:01 -07008default: serve
Matteo Scandolof8cd29f2017-09-07 13:57:26 -07009
Zack Williams2d04b0d2017-09-25 14:19:55 -070010# use bash for pushd/popd, and to fail if commands within a pipe fail
11SHELL = bash -o pipefail
12
Zack Williams1b96a952017-07-17 16:48:01 -070013GENERATED_DOCS = build_glossary.md
llpbd786de2017-07-07 15:57:27 -070014
Zack Williams1b96a952017-07-17 16:48:01 -070015serve: setup
Matteo Scandolo8a76f922017-08-29 14:02:58 -070016 gitbook serve
llp18276982017-07-11 11:28:47 -070017
Zack Williams1b96a952017-07-17 16:48:01 -070018build: setup
19 gitbook build
20
Zack Williams144027f2017-09-25 18:01:47 -070021setup: clean platform-install cord-tester profiles xos xos-gui xos-tosca swagger $(GENERATED_DOCS)
Zack Williams1b96a952017-07-17 16:48:01 -070022 gitbook init
23 gitbook install
24
Zack Williams144027f2017-09-25 18:01:47 -070025test: linkcheck
26
27linkcheck: build
28 linkchecker -a _book/
29
Zack Williams1b96a952017-07-17 16:48:01 -070030platform-install:
31 ln -s ../platform-install/docs platform-install
32
Zack Williams144027f2017-09-25 18:01:47 -070033cord-tester:
34 ln -s ../../test/cord-tester/docs cord-tester
Zack Williams1b96a952017-07-17 16:48:01 -070035
36profiles:
Luca Preteb68031d2017-09-28 13:52:54 -070037 mkdir -p profiles/rcord profiles/ecord profiles/mcord profiles/opencloud
38 ln -s ../../../../orchestration/profiles/rcord/docs/README.md profiles/rcord/
39 ln -s ../../../../orchestration/profiles/ecord/docs/README.md profiles/ecord/
40 ln -s ../../../../orchestration/profiles/mcord/docs/README.md profiles/mcord/
41 ln -s ../../../../orchestration/profiles/opencloud/docs/README.md profiles/opencloud/
Zack Williams1b96a952017-07-17 16:48:01 -070042
43xos:
44 ln -s ../../orchestration/xos/docs xos
45
46xos-gui:
47 ln -s ../../orchestration/xos-gui/docs xos-gui
48
49xos-tosca:
50 ln -s ../../orchestration/xos-tosca/docs xos-tosca
51
52build_glossary.md: scripts/descriptions.md scripts/defaults.md.j2 scripts/defaultsdoc.py scripts/markedyaml.py
53 python scripts/defaultsdoc.py -o build_glossary.md
54
55swagger: xos
Matteo Scandolof8cd29f2017-09-07 13:57:26 -070056 pushd ../../orchestration/xos/docs/; make swagger_docs; popd;
57
Zack Williams1b96a952017-07-17 16:48:01 -070058clean:
59 rm -rf $(GENERATED_DOCS)
60 rm -rf _book
61 rm -rf node_modules
Luca Preteb68031d2017-09-28 13:52:54 -070062 rm -rf platform-install test profiles xos xos-gui xos-tosca
Zack Williams1b96a952017-07-17 16:48:01 -070063