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.

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

fix: update broken links #2945

Merged
merged 1 commit into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@
~ limitations under the License.
~
-->

<!--
Thanks for contributing! Here are some tips you can follow to help us incorporate your contribution quickly and easily:
1. If this is your first time, please read our contributor guidelines:
- https://streampipes.apache.org/getinvolved.html
- https://streampipes.apache.org/community/get-involved/
- https://cwiki.apache.org/confluence/display/STREAMPIPES/Getting+Started
2. Make sure the PR title is formatted like: `[#<GitHub issue id>] PR title ...`
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., `[WIP][#<GitHub issue id>] PR title ...`.
4. Please write your PR title to summarize what this PR proposes/fixes.
5. Link the PR to the corresponding GitHub issue (if present) in the `Development` section in the right menu bar.
5. Link the PR to the corresponding GitHub issue (if present) in the `Development` section in the right menu bar.
6. Be sure to keep the PR description updated to reflect all changes.
7. If possible, provide a concise example to reproduce the issue for a faster review.
8. Make sure tests pass via `mvn clean install`.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## Contributing to StreamPipes

*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/getinvolved.html) page.
*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/community/get-involved/) page.
It lists information that is required for contributing to StreamPipes.

When you contribute code, you affirm that the contribution is your original work and that you
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@

<h1 align="center">
<br>
<img src="https://streampipes.apache.org/img/sp-logo-color.png"
<img src="https://streampipes.apache.org/img/sp-logo-color.png"
alt="StreamPipes Logo" title="Apache StreamPipes Logo" width="50%"/>
<br>
</h1>
<h3 align="center">Self-Service Data Analytics for the (Industrial) IoT</h3>
<h4 align="center">StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect
, analyze and explore IoT data streams. </h4>
<p align="center">
<p align="center">
<img src="https://raw.githubusercontent.com/apache/streampipes/dev/images/streampipes-overview.png" alt="StreamPipes Overview"/>
</p>

Expand All @@ -53,7 +53,7 @@
* [Installation](#installation)
* [Documentation](#documentation)
* [Building StreamPipes](#building-streampipes)
* [Pipeline Elements](#pipeline-elements)
* [Pipeline Elements](#pipeline-elements)
* [Extending StreamPipes](#extending-streampipes)
* [Bugs and Feature Requests](#bugs-and-feature-requests)
* [Get help](#get-help)
Expand All @@ -67,7 +67,7 @@

Apache StreamPipes makes industrial data analytics easy!

StreamPipes is an end-to-end toolbox for the industrial IoT.
StreamPipes is an end-to-end toolbox for the industrial IoT.
It comes with a rich graphical user interface targeted at non-technical users and provides the following features:


Expand All @@ -77,8 +77,8 @@ It comes with a rich graphical user interface targeted at non-technical users an
* A live dashboard to display real-time data from data sources and pipelines, e.g., for shopfloor monitoring.


StreamPipes is highly extensible and includes a Java SDK to create new
pipeline elements and adapters. Python support is available in an early development stage - stay tuned!
StreamPipes is highly extensible and includes a Java SDK to create new
pipeline elements and adapters. Python support is available in an early development stage - stay tuned!
Pipeline elements are standalone microservices that can run anywhere -
centrally on your server or close at the edge.
You want to employ your own machine learning model on live data?
Expand Down Expand Up @@ -108,13 +108,13 @@ Besides that, StreamPipes includes features for production deployments:

## Installation

The quickest way to run StreamPipes including the latest extensions (adapters, pipeline elements) is by using our Docker-based [installation & operation options](installer), namely:
The quickest way to run StreamPipes including the latest extensions (adapters, pipeline elements) is by using our Docker-based [installation & operation options](installer), namely:

* **[StreamPipes Compose](installer/compose)** - The User's Choice
* **[StreamPipes CLI](installer/cli)** - The Developer's Favorite
* **[StreamPipes k8s](installer/k8s)** - The Operator's Dream

> [!IMPORTANT]
> [!IMPORTANT]
> StreamPipes CLI & k8s are highly recommended for developers or operators. Standard users should stick to StreamPipes Compose.

Please follow the instructions provided in the corresponding `README.md` to get started.
Expand Down Expand Up @@ -168,14 +168,14 @@ You can also use the installer or CLI as described in the ``Installation`` secti

## Pipeline Elements
StreamPipes includes a repository of extensions for adapters and pipeline elements:
* **Connect adapters** for a variety of IoT data sources as well as
* **Data Processors** and **Data Sinks** as ready-to-use pipeline elements.
* **Connect adapters** for a variety of IoT data sources as well as
* **Data Processors** and **Data Sinks** as ready-to-use pipeline elements.

The source code of all included pipeline elements and adapters can be found [here](https://github.com/apache/streampipes/tree/dev/streampipes-extensions).

## Extending StreamPipes

You can easily add your own data streams, processors or sinks. A [Java-based SDK](https://streampipes.apache.org/docs/extend-tutorial-data-processors.html) can be used to integrate your existing processing logic into StreamPipes.
You can easily add your own data streams, processors or sinks. A [Java-based SDK](https://streampipes.apache.org/docs/extend-tutorial-data-processors.html) can be used to integrate your existing processing logic into StreamPipes.
Pipeline elements are packaged as Docker images and can be installed at runtime, whenever your requirements change.

👉 Check our [developer guide](https://streampipes.apache.org/docs/extend-setup.html).
Expand All @@ -189,10 +189,10 @@ If you've found a bug or have a feature that you'd love to see in StreamPipes, f

## Get help

If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our
community channels:

👉 [Mailing Lists](https://streampipes.apache.org/mailinglists.html)
👉 [Mailing Lists](https://streampipes.apache.org/community/mailing-lists/)

Or directly subscribe to [[email protected]](mailto:[email protected])!

Expand Down
6 changes: 3 additions & 3 deletions installer/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ streampipes up -d
```
Now you're good to go to write your new pipeline element :tada: :tada: :tada:

> **HINT for extensions**: Use our [Maven archetypes](https://streampipes.apache.org/docs/docs/dev-guide-archetype/) to setup a project skeleton and use your IDE of choice for development. However, we do recommend using IntelliJ.
> **HINT for extensions**: Use our [Maven archetypes](https://streampipes.apache.org/docs/extend-archetypes/) to setup a project skeleton and use your IDE of choice for development. However, we do recommend using IntelliJ.

> **HINT for core**: To work on `backend` or `ui` features you need to set the template to `backend` and clone the core repository [streampipes](https://github.com/apache/streampipes) - check the prerequisites there for more information.

Expand Down Expand Up @@ -163,7 +163,7 @@ streampipes start extensions-all-jvm
**Restart** existing services
```bash
# restart backend couchdb container
streampipes restart backend couchdb
streampipes restart backend couchdb
# restart existing services by removing and recreating container instance
streampipes restart --force-create extensions-all-jvm
```
Expand Down Expand Up @@ -263,7 +263,7 @@ If you've found a bug or have a feature that you'd love to see in StreamPipes, f
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:

- [Slack](https://slack.streampipes.org)
- [Mailing Lists](https://streampipes.apache.org/mailinglists.html)
- [Mailing Lists](https://streampipes.apache.org/community/mailing-lists/)

And don't forget to follow us on [Twitter](https://twitter.com/streampipes)!

Expand Down
8 changes: 4 additions & 4 deletions installer/compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ StreamPipes Compose is a simple collection of user-friendly `docker-compose` fil
```bash
docker-compose up -d
```
Go to http://localhost to finish the installation in the browser. Once finished, switch to the pipeline editor and start the interactive tour or check the [online tour](https://streampipes.apache.org/docs/docs/user-guide-tour/) to learn how to create your first pipeline!
Go to http://localhost to finish the installation in the browser. Once finished, switch to the pipeline editor and start the interactive tour or check the [online tour](https://streampipes.apache.org/docs/user-guide-tour/) to learn how to create your first pipeline!

## Prerequisite
* Docker >= 17.06.0
Expand All @@ -50,7 +50,7 @@ We provide three options to get you going:
- **full**: contains experimental Flink wrappers
- **quickstart**: contains pre-configured sample assets, including pipelines, dashboards, and data views. We recommend first-time StreamPipes users to use the Quickstart mode to experience the convenience of StreamPipes in IIoT! (Recommended for first-time users)

The ``nats`` version will become the default version in a later release. You can already try it for new installations,
The ``nats`` version will become the default version in a later release. You can already try it for new installations,
but there's not yet an automatic migration from current Kafka-based installations to Nats.

**Starting** the **default** option is as easy as simply running:
Expand All @@ -60,7 +60,7 @@ but there's not yet an automatic migration from current Kafka-based installation
docker-compose up -d
# go to `http://localhost` after all services are started
```
After all containers are successfully started just got to your browser and visit http://localhost to finish the installation. Once finished, switch to the pipeline editor and start the interactive tour or check the [documentation](https://streampipes.apache.org/docs/docs/user-guide-introduction.html) to learn more about StreamPipes!
After all containers are successfully started just got to your browser and visit http://localhost to finish the installation. Once finished, switch to the pipeline editor and start the interactive tour or check the [documentation](https://streampipes.apache.org/docs/user-guide-introduction/) to learn more about StreamPipes!

**Stopping** the **default** option is similarly easy:
```bash
Expand Down Expand Up @@ -123,7 +123,7 @@ Since we purely levarage Docker Compose, please see their [documentation](https:
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:

- [Slack](https://slack.streampipes.org)
- [Mailing Lists](https://streampipes.apache.org/mailinglists.html)
- [Mailing Lists](https://streampipes.apache.org/community/mailing-lists/)

And don't forget to follow us on [Twitter](https://twitter.com/streampipes)!

Expand Down
2 changes: 1 addition & 1 deletion installer/k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ If you have any problems during the installation or questions around StreamPipes
community channels:

- [Slack](https://slack.streampipes.org)
- [Mailing Lists](https://streampipes.apache.org/mailinglists.html)
- [Mailing Lists](https://streampipes.apache.org/community/mailing-lists/)

And don't forget to follow us on [Twitter](https://twitter.com/streampipes)!

Expand Down
10 changes: 5 additions & 5 deletions streampipes-client-python/docs/getting-started/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This document describes how to easily set up your local dev environment to work

1) **Set up your Python environment**

Create a virtual Python environment using a tool of your choice.
Create a virtual Python environment using a tool of your choice.
To manage dependencies, we use [Poetry](https://python-poetry.org/), so please install poetry in your local environment, e.g. via
```bash
pip install poetry
Expand All @@ -44,7 +44,7 @@ poetry install --with dev,stubs,docs # install all optional dependencies relate

The pre-commit hook is run before every commit and takes care about code style,
linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format.
Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail.
Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail.
If you are interested, you can have a deeper look on the underlying library: [pre-commit](https://pre-commit.com/).

```bash
Expand All @@ -67,7 +67,7 @@ Please stick to the `numpy` [style](https://numpydoc.readthedocs.io/en/latest/fo
2) **Provide tests** ✅ <br>
We are aiming for broad test coverage for the Python package and
have therefore set a requirement of at least 90% unit test coverage.
Therefore, please remember to write (unit) tests already during development.
Therefore, please remember to write (unit) tests already during development.
If you have problems with writing tests, don't hesitate to ask us for help directly in the PR or
even before that via our mailing list (see above).

Expand Down Expand Up @@ -127,7 +127,7 @@ Stay tuned!

---
## 👨‍💻 Contributing
*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/getinvolved.html) page.
*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/community/get-involved/) page.
It lists information that is required for contributing to StreamPipes.

When you contribute code, you affirm that the contribution is your original work and that you
Expand All @@ -136,4 +136,4 @@ state this explicitly, by submitting any copyrighted material via pull request,
other means you agree to license the material under the project's open source license and
warrant that you have the legal authority to do so.

---
---
6 changes: 3 additions & 3 deletions streampipes-client-python/docs/getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
... ... ... ... ... ... ...
```
Otherwise, you need to start docker first.
Please read the full guide on how to start StreamPipes with `docker compose` [here](https://streampipes.apache.org/docs/docs/deploy-docker.html).
Please read the full guide on how to start StreamPipes with `docker compose` [here](https://streampipes.apache.org/docs/deploy-docker/).

#### Setup StreamPipes with NATS as message broker
The following shows how you can set up a StreamPipes instance that uses [NATS](https://docs.nats.io/) as messaging layer.
So in this scenario, we will go with `docker-compose.nats.yml`.
So in this scenario, we will go with `docker-compose.nats.yml`.
Thereby, when running locally, we need to add the following port mapping entry to `services.nats.ports`:
```yaml
- 4222:4222
Expand Down Expand Up @@ -85,6 +85,6 @@ docker-compose -f docker-compose.yml up -d
Once all services are started, you can access StreamPipes via `http://localhost`.

In case you want to have more control over your StreamPipes setup,
you might take a look at our [deployment CLI](https://streampipes.apache.org/docs/docs/extend-cli.html).
you might take a look at our [deployment CLI](https://streampipes.apache.org/docs/extend-cli/).

Have fun discovering StreamPipes and our Python library 🚀
Loading