From 30eb4e11fba83da8f52610747d2e94be944268c1 Mon Sep 17 00:00:00 2001 From: Avgustin Marinov Date: Wed, 27 Sep 2023 14:02:25 +0300 Subject: [PATCH] Small fix/improvements over swagger based doc (#1439) Signed-off-by: Marinov Avgustin --- .gitignore | 4 ---- .gitmodules | 0 docs/.gitignore | 12 ++++++++++++ docs/README.md | 2 +- docs/build-htmls.sh | 2 +- docs/themes/hugo-material-docs | 1 - 6 files changed, 14 insertions(+), 7 deletions(-) delete mode 100644 .gitmodules create mode 100644 docs/.gitignore delete mode 160000 docs/themes/hugo-material-docs diff --git a/.gitignore b/.gitignore index b2493f873..c66e897c5 100644 --- a/.gitignore +++ b/.gitignore @@ -62,8 +62,4 @@ maven.properties *.tmp # Documentation -docs/themes/** -docs/public/** -docs/content/rest-api/*.html -docs/.hugo_build.lock .gitmodules diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..19ea11e3f --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,12 @@ +# rest api doc +content/rest-api/*.json +content/rest-api/*.html +# npm leftover +node_modules +package.json +package-lock.json +# themse +themes +# hugo +public +.hugo_build.lock diff --git a/docs/README.md b/docs/README.md index 3f68367f8..198b86113 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ theme. Compiling the documentation is not included within the regular Maven buil ## Prerequisites 1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to install Hugo. -2. **INSTALL JQ**: see [installing jq](https://jqlang.github.io/jq/download/) documentation on how to install jq. +2. **Install JQ**: see [installing jq](https://jqlang.github.io/jq/download/) documentation on how to install jq. 3. **Install NODE.js and npm** see [installing Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) documentation on how to install Node.js and npm 4. **Install Redocly CLI** see [installing Redocly CLI](https://redocly.com/docs/cli/installation/) documentation on how to install Redocly CLI 5. **Install hawkBit**: run `mvn install` in the parent directory to generate the latest REST docs for hawkBit. diff --git a/docs/build-htmls.sh b/docs/build-htmls.sh index 2a103591a..0f0a61693 100644 --- a/docs/build-htmls.sh +++ b/docs/build-htmls.sh @@ -14,7 +14,7 @@ CURRENT_DIR=$(pwd) # Checking for Redoc CLI and npm -redoc-cli --version > /dev/null 2>&1 +npx @redocly/cli --version > /dev/null 2>&1 if [ $? != 0 ]; then echo "[ERROR] Redoc CLI is not installed! Please make suer to install it before trying again." diff --git a/docs/themes/hugo-material-docs b/docs/themes/hugo-material-docs deleted file mode 160000 index 9dbd25cf9..000000000 --- a/docs/themes/hugo-material-docs +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 9dbd25cf9474f3a8bc4c09ec4c7965c8fdee9a5f