Small fix/improvements over swagger based doc (#1439)
Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
4
.gitignore
vendored
4
.gitignore
vendored
@@ -62,8 +62,4 @@ maven.properties
|
|||||||
*.tmp
|
*.tmp
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
docs/themes/**
|
|
||||||
docs/public/**
|
|
||||||
docs/content/rest-api/*.html
|
|
||||||
docs/.hugo_build.lock
|
|
||||||
.gitmodules
|
.gitmodules
|
||||||
|
|||||||
0
.gitmodules
vendored
0
.gitmodules
vendored
12
docs/.gitignore
vendored
Normal file
12
docs/.gitignore
vendored
Normal file
@@ -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
|
||||||
@@ -4,7 +4,7 @@ theme. Compiling the documentation is not included within the regular Maven buil
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to install Hugo.
|
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
|
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
|
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.
|
5. **Install hawkBit**: run `mvn install` in the parent directory to generate the latest REST docs for hawkBit.
|
||||||
|
|||||||
@@ -14,7 +14,7 @@
|
|||||||
CURRENT_DIR=$(pwd)
|
CURRENT_DIR=$(pwd)
|
||||||
|
|
||||||
# Checking for Redoc CLI and npm
|
# Checking for Redoc CLI and npm
|
||||||
redoc-cli --version > /dev/null 2>&1
|
npx @redocly/cli --version > /dev/null 2>&1
|
||||||
|
|
||||||
if [ $? != 0 ]; then
|
if [ $? != 0 ]; then
|
||||||
echo "[ERROR] Redoc CLI is not installed! Please make suer to install it before trying again."
|
echo "[ERROR] Redoc CLI is not installed! Please make suer to install it before trying again."
|
||||||
|
|||||||
1
docs/themes/hugo-material-docs
vendored
1
docs/themes/hugo-material-docs
vendored
Submodule docs/themes/hugo-material-docs deleted from 9dbd25cf94
Reference in New Issue
Block a user