From 943864231aa4caf367ae86a066c1ef63c3d17d41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Benencia?= Date: Tue, 8 Jan 2019 19:45:19 -0800 Subject: Rename example-templates-configs to data-dir --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a1309ae..1bfe2d8 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Shoelaces accepts several parameters: * `config`: the path to a configuration file. * `data-dir`: the path to the root directory with the templates. It's advised to manage the templates in a VCS, such as a git repository. Refer to the [example - data directory](configs/example-templates-configs/) for more information. + data directory](configs/data-dir/) for more information. * `debug`: enable debug messages. * `domain`: the domain Shoelaces is going to be listening on. * `mappings-file`: the path to the YAML mappings file, relative to the `data-dir` parameter. @@ -178,7 +178,7 @@ that. Shoelaces will read these mappings from a YAML file that can be passed as a program parameter. Refer to the [example mappings -file](configs/example-templates-configs/mappings.yaml) for more information. +file](configs/data-dir/mappings.yaml) for more information. ## Environments -- cgit v1.2.3 From b27b7bfd4e95b35a5dbce225ac135287a8bbdb24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Benencia?= Date: Tue, 8 Jan 2019 19:48:29 -0800 Subject: Move screenshots to docs/screenshots --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1bfe2d8..a76ef52 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ As soon as Shoelaces starts, the service will be patiently waiting for servers to boot. If no servers are detected, you'll simply see a spinner in the web UI, as can be seen in the screenshot. -![Shoelaces frontend - Waiting for hosts](shoelaces-frontend-1.png) +![Shoelaces frontend - Waiting for hosts](docs/screenshots/shoelaces-frontend-1.png) The URL `localhost:8081` will actually point to wherever you are running your Shoelaces instance. It must be reachable by the booting hosts. @@ -30,7 +30,7 @@ Shoelaces instance. It must be reachable by the booting hosts. The following picture shows a high level overview of how a server notifies Shoelaces that it's ready for booting. -![Shoelaces overview](shoelaces-overview.png) +![Shoelaces overview](docs/screenshots/shoelaces-overview.png) In this graph we can see that as soon as the server boots using network boot, we instruct the machine to switch to an [iPXE](https://ipxe.org/) ROM. We do this @@ -50,7 +50,7 @@ guessed, will be pointing to Shoelaces. If there was no automated installation configured for the booting server, you'll be able to select an option to bootstrap it in the Shoelaces UI. -![Shoelaces frontend - Host detected](shoelaces-frontend-2.png) +![Shoelaces frontend - Host detected](docs/screenshots/shoelaces-frontend-2.png) A couple of things can be said about this screenshot: -- cgit v1.2.3