From 94b9d11292812655a9dcefc1d8e96b672e41862f Mon Sep 17 00:00:00 2001 From: Rohan Udupa <86579136+lab596@users.noreply.github.com> Date: Thu, 7 Sep 2023 11:46:38 -0700 Subject: [PATCH 1/2] updating beginner documentation --- README.md | 4 ++-- docs/06_extend-cli.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a017c07f7..645af2cdc 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ Two different technologies are used to create both sites: Both parts are merged to a single directory during the CI process. -Node.js and npm are required to build the documentation. +Node.js(v14 - v16) and npm are required to build the documentation. ## Build Website & Documentation -* Run ``npm install`` from the ``website-v2`` directory. +* Run ``npm install`` from the ``website-v2`` directory by first running ``cd ./website-v2``. * Run ``npm run start`` to start the documentation for debugging purposes. The content will be served on ``http://localhost:3000`` * Run ``npm run build`` to build the documentation This will create a folder ``website-v2/build`` that includes all required static files. * Run ``npm run ds-version NEW_VERSION`` to release a new docs version. diff --git a/docs/06_extend-cli.md b/docs/06_extend-cli.md index 16315182b..805501349 100644 --- a/docs/06_extend-cli.md +++ b/docs/06_extend-cli.md @@ -23,7 +23,7 @@ pipeline-element streampipes env --set pipeline-element streampipes up -d ``` -> **NOTE**: use `./streampipes` if you haven't add it to the PATH and sourced it (see section "Run `streampipes` from anywhere?"). +> **NOTE**: use `./installer/cli/streampipes` if you haven't add it to the PATH and sourced it (see section "Run `streampipes` from anywhere?"). ## Prerequisites The CLI is basically a wrapper around multiple `docker` and `docker-compose` commands plus some additional sugar. @@ -34,9 +34,9 @@ The CLI is basically a wrapper around multiple `docker` and `docker-compose` com * For Windows Developer: GitBash only -Tested on: **macOS**, **Linux**, **Windows***) +Tested on: (***macOS**, **Linux**, **Windows***) -> **NOTE**: *) If you're using Windows the CLI only works in combination with GitBash - CMD, PowerShell won't work. +> **NOTE**: If you're using Windows the CLI only works in combination with GitBash - CMD, PowerShell won't work. ## CLI commands overview @@ -183,7 +183,7 @@ For **macOS**, or **Linux**: export PATH="/path/to/streampipes-installer/installer/cli:$PATH" ``` -For **Windows 10**, e.g. check this [documentation](https://helpdeskgeek.com/windows-10/add-windows-path-environment-variable/). +For **Windows 10** add `installer\cli` to environment variables, e.g. check this [documentation](https://helpdeskgeek.com/windows-10/add-windows-path-environment-variable/). ## Upgrade to new version From 65eb5d9c45ce3be75ee5e1f62f42e7acdd6341e4 Mon Sep 17 00:00:00 2001 From: Rohan Udupa <86579136+lab596@users.noreply.github.com> Date: Fri, 8 Sep 2023 21:14:12 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 645af2cdc..05bbef04d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Two different technologies are used to create both sites: Both parts are merged to a single directory during the CI process. -Node.js(v14 - v16) and npm are required to build the documentation. +Node.js(at most v18) and npm are required to build the documentation. ## Build Website & Documentation