Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating Beginner Documentation #105

Merged
merged 2 commits into from
Sep 9, 2023
Merged

Updating Beginner Documentation #105

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94b9d11
updating beginner documentation
lab596 Sep 7, 2023
65eb5d9
Update README.md
lab596 Sep 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you think we are only compatible to Node v14 to 16?
Our PR validation and deployment both run in Node version 18


## 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.
Expand Down
8 changes: 4 additions & 4 deletions docs/06_extend-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading