Skip to content

Commit 1b278aa

Browse files
authored
Add base path note to README file (#943)
Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>
1 parent 9b50e32 commit 1b278aa

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,11 @@ One option to serve your landscape in production is to use a static site hosting
180180
> [!NOTE]
181181
> The resulting website when building a landscape is a [single-page application](https://en.wikipedia.org/wiki/Single-page_application) that handles routing on the client side. This means that you'll need to configure your webserver to serve the `index.html` file for the SPA route paths (like '/guide', '/stats', etc). One way of doing this would be to serve that file when a non existent path is requested. The `serve` subcommand included in **landscape2** already handles this for us. In the GitHub pages example mentioned above, this is achieved by copying the content of the `index.html` file to the `404.html` file, which will be served when a non existent path is requested.
182182
183+
> [!NOTE]
184+
> If you plan to host the generated landscape in a subpath instead of at the
185+
> root of your domain (for example `/landscape`), make sure to set the
186+
> `base_path` field in your `settings.yml` file accordingly.
187+
183188
### Validating data, settings and guide files
184189

185190
The **landscape2** CLI tool includes a subcommand named `validate` that allows you to check that your landscape data, settings and guide files are valid. If you are interested in integrating this validation in your CI workflows (i.e. to enforce that those files are valid before merging a PR), please take a look at the [landscape2-validate-action](https://github.com/cncf/landscape2-validate-action).

0 commit comments

Comments
 (0)