Gitiles
Code Review Sign In
gerrit.opencord.org / docs / 7f7b1aa1dd3c2342a9438693f0eeca3b5e3c5cc3 / . / Makefile
blob: 39538b3ade78bb5f41435017a66da0143537f6ef [file] [log] [blame]
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]1# 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
8default: serve
9
10# use bash for pushd/popd, and to fail if commands within a pipe fail
11SHELL = bash -o pipefail
12
13GENERATED_DOCS =
14
Zack Williamsa719e4a2018-05-16 14:44:36 -0700[diff] [blame]15LINT_STYLE ?= mdl_relaxed.rb
16
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]17serve: setup
Matteo Scandoloc93f6332018-05-25 15:19:43 -0700[diff] [blame]18 npm start
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]19
20build: setup
21 gitbook build
22
Scott Baker7f7b1aa2018-05-31 16:53:30 -0700[diff] [blame^]23setup: automation-tools cord-tester fabric hippie-oss kubernetes-service olt-service openolt rcord vrouter xos xos-gui xos-tosca swagger $(GENERATED_DOCS)
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]24 gitbook init
25 gitbook install
26
27test: linkcheck lint
28
29linkcheck: build
30 linkchecker --check-extern -a _book/
31
32lint:
33 @echo "markdownlint(mdl) version: `mdl --version`"
34 @echo "style config:"
35 @echo "---"
Zack Williamsa719e4a2018-05-16 14:44:36 -0700[diff] [blame]36 @cat $(LINT_STYLE)
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]37 @echo "---"
Zack Williamsa719e4a2018-05-16 14:44:36 -0700[diff] [blame]38 mdl -s $(LINT_STYLE) `find -L . ! -path "./partials/*" ! -path "./_book/*" ! -path "./node_modules/*" ! -path "./cord-tester/modules/*" -name "*.md"`
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]39
40# link directories that contain other documentation
Luca Pretee62616d2018-05-24 14:40:18 -0700[diff] [blame]41automation-tools:
42 ln -s ../automation-tools automation-tools
43
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]44cord-tester:
45 ln -s ../test/cord-tester/docs cord-tester
46
Matteo Scandolo821477f2018-05-29 08:43:13 -0700[diff] [blame]47fabric:
48 ln -s ../orchestration/xos_services/fabric/docs fabric
49
Matteo Scandolo389c5632018-05-31 10:26:39 -0700[diff] [blame]50hippie-oss:
51 ln -s ../orchestration/xos_services/hippie-oss/docs hippie-oss
52
53olt-service:
54 ln -s ../orchestration/xos_services/olt-service/docs olt-service
55
Scott Baker7f7b1aa2018-05-31 16:53:30 -0700[diff] [blame^]56kubernetes-service:
57 ln -s ../orchestration/xos_services/kubernetes-service/docs kubernetes-service
58
Matteo Scandolof590a0a2018-05-30 15:32:09 -0700[diff] [blame]59openolt:
60 ln -s ../incubator/openolt openolt
61
Matteo Scandolo389c5632018-05-31 10:26:39 -0700[diff] [blame]62rcord:
63 ln -s ../orchestration/profiles/rcord/docs rcord
64
Matteo Scandolo821477f2018-05-29 08:43:13 -0700[diff] [blame]65vrouter:
66 ln -s ../orchestration/xos_services/vrouter/docs vrouter
67
Zack Williamsad366132018-05-14 14:45:47 -0700[diff] [blame]68xos:
69 ln -s ../orchestration/xos/docs xos
70
71xos-gui:
72 ln -s ../orchestration/xos-gui/docs xos-gui
73
74xos-tosca:
75 ln -s ../orchestration/xos-tosca/docs xos-tosca
76
77swagger: xos
78 pushd ../orchestration/xos/docs/; make swagger_docs; popd;
79
80clean:
81 rm -rf $(GENERATED_DOCS)
82 rm -rf _book
83 rm -rf node_modules
Scott Baker7f7b1aa2018-05-31 16:53:30 -0700[diff] [blame^]84 rm -rf automation-tools cord-tester fabric hippie-oss kubernetes-service olt-service openolt rcord vrouter test xos xos-gui xos-tosca