This is an automated email from the ASF dual-hosted git repository.
snazy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 0316c32 Add docs/build command with `--rm` option (#210)
0316c32 is described below
commit 0316c3281c1a08cae528f01270da12ddc1ce1dc3
Author: Yuya Ebihara <[email protected]>
AuthorDate: Mon Aug 26 20:09:33 2024 +0900
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(-)
diff --git a/README.md b/README.md
index df6daa1..f785989 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 0000000..c396639
--- /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