Updating CLI Documentation (#105)

* updating beginner documentation * Update README.md
apache · Sep 9, 2023 · 73c6f1a · 73c6f1a
1 parent bdce98e
commit 73c6f1a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git 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(at most v18) 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
@@ -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