From 0316c3281c1a08cae528f01270da12ddc1ce1dc3 Mon Sep 17 00:00:00 2001 From: Yuya Ebihara Date: Mon, 26 Aug 2024 20:09:33 +0900 Subject: [PATCH] Add docs/build command with `--rm` option (#210) Add docs/build command so that we can execute the command more easily. --- README.md | 3 +-- docs/build | 6 ++++++ 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100755 docs/build diff --git a/README.md b/README.md index df6daa119..f78598980 100644 --- a/README.md +++ b/README.md @@ -83,8 +83,7 @@ Building docs - Docs are generated using [Redocly](https://redocly.com/docs/cli/installation). To regenerate them, run the following commands from the project root directory. ```bash -docker run -p 8080:80 -v ${PWD}:/spec docker.io/redocly/cli join spec/docs.yaml spec/polaris-management-service.yml spec/rest-catalog-open-api.yaml -o spec/index.yaml --prefix-components-with-info-prop title -docker run -p 8080:80 -v ${PWD}:/spec docker.io/redocly/cli build-docs spec/index.yaml --output=docs/index.html --config=spec/redocly.yaml +docs/build ``` ## License diff --git a/docs/build b/docs/build new file mode 100755 index 000000000..c396639bf --- /dev/null +++ b/docs/build @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +set -eux + +docker run -p 8080:80 -v ${PWD}:/spec --rm docker.io/redocly/cli join spec/docs.yaml spec/polaris-management-service.yml spec/rest-catalog-open-api.yaml -o spec/index.yaml --prefix-components-with-info-prop title +docker run -p 8080:80 -v ${PWD}:/spec --rm docker.io/redocly/cli build-docs spec/index.yaml --output=docs/index.html --config=spec/redocly.yaml