diff --git a/docs/Makefile b/docs/Makefile index f2a6d70b..f2315b3c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,7 +10,7 @@ diagrams: && python3 * .PHONY: book -book: +book: diagrams mdbook build . .PHONY: deploy diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..58cf9a55 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +# Documents + +The documents can be viewed at . + +To view locally, install [`mdbook`](https://github.com/rust-lang/mdBook#installation) and run: + +``` +mdbook serve +``` diff --git a/docs/deployment/provisioning_flow.md b/docs/deployment/provisioning_flow.md index aa7e5d13..4d0f5665 100644 --- a/docs/deployment/provisioning_flow.md +++ b/docs/deployment/provisioning_flow.md @@ -1,5 +1,5 @@ # Provisioning flow -![Provisioning flow](https://user-images.githubusercontent.com/27996771/122676008-2eb23600-d206-11eb-8275-fb5d99bc8515.jpg) +![Provisioning flow](../diagrams/provisioning_flow.jpg) TODO diff --git a/docs/diagrams/provision.py b/docs/diagrams/provision.py index 3c6b6fed..fcfc4f24 100644 --- a/docs/diagrams/provision.py +++ b/docs/diagrams/provision.py @@ -12,7 +12,7 @@ graph_attr = { "pad": "0" } -with Diagram("Provision (separated by logical layers)", graph_attr=graph_attr, outformat="jpg", show=False): +with Diagram("Provisioning flow", graph_attr=graph_attr, outformat="jpg", show=False): controller = Client("Initial controller") bare_metal_machines = Server(f"Server(s)")