This is an automated email from the ASF dual-hosted git repository. bossenti pushed a commit to branch refactor/remove-readme in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 3032d0f9f89bdf8c90ecd6064b99e3c62ef53a05 Author: bossenti <[email protected]> AuthorDate: Thu Jan 26 19:31:12 2023 +0100 remove outdated README files --- installer/README.md | 78 --------------------------- streampipes-extensions/README.md | 110 --------------------------------------- 2 files changed, 188 deletions(-) diff --git a/installer/README.md b/installer/README.md deleted file mode 100644 index 754d083c8..000000000 --- a/installer/README.md +++ /dev/null @@ -1,78 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - ~ - --> - -# Apache StreamPipes installer -This project contains a variety of StreamPipes installation and operation options, namely: - -* **[StreamPipes Compose](./compose)** - The User's Choice -* **[StreamPipes CLI](./cli)** - The Developer's Favorite -* **[StreamPipes k8s](./k8s)** - The Operator's Dream - -> **NOTE**: StreamPipes CLI & k8s are highly recommended for developers or operators. Standard users should stick to StreamPipes Compose. - -This is useful in order to easily spin up StreamPipes' microservice environment consisting of: - -* **backend**, **connect master** and **ui** container (see [streampipes](https://github.com/apache/streampipes)) -* **extensions**, i.e. connect adapter, custom sources and pipeline elements (see [streampipes-extensions](https://github.com/apache/streampipes-extensions)), as well as -* mandatory **third-party services** such as databases, message broker etc. - -## How to get started? -Clone this project -```bash -git clone https://github.com/apache/streampipes-installer -``` -or download the ZIP of the installer. Click on the green button `Code` on the top right. Then click on `Download ZIP`. - -## Upgrade version for all options -To upgrade the StreamPipes version all at once for all options and README files you can use the little helper script. -> **IMPORTANT**: This script does not check for valid version input. - -```bash -./upgrade_versions.sh <version> -``` - -## Bugs and Feature Requests - -If you've found a bug or have a feature that you'd love to see in StreamPipes, feel free to create an issue on [GitHub](https://github.com/apache/streampipes/issues): - -## Get help -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) - -And don't forget to follow us on [Twitter](https://twitter.com/streampipes)! - -## Contribute -We welcome contributions to StreamPipes. If you are interested in contributing to StreamPipes, let us know! You'll - get to know an open-minded and motivated team working together to build the next IIoT analytics toolbox. - -Here are some first steps in case you want to contribute: -* Subscribe to our dev mailing list [[email protected]]([email protected]) -* Send an email, tell us about your interests and which parts of StreamPipes you'd like to contribute (e.g., core or UI)! -* Ask for a mentor who helps you understanding the code base and guides you through the first setup steps -* Find an issue on [GitHub](https://github.com/apache/streampipes/issues) which is tagged with a _good first issue_ tag -* Have a look at our developer wiki at [https://cwiki.apache.org/confluence/display/STREAMPIPES](https://cwiki.apache.org/confluence/display/STREAMPIPES) to learn more about StreamPipes development. - -Have fun! - -## Feedback -We'd love to hear your feedback! Subscribe to [[email protected]](mailto:[email protected]) - -## License -[Apache License 2.0](LICENSE) diff --git a/streampipes-extensions/README.md b/streampipes-extensions/README.md deleted file mode 100644 index c7c1fc385..000000000 --- a/streampipes-extensions/README.md +++ /dev/null @@ -1,110 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You under the Apache License, Version 2.0 - ~ (the "License"); you may not use this file except in compliance with - ~ the License. You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - ~ - --> -[](https://github.com/apache/streampipes-extensions/actions/) -# Apache StreamPipes - -Apache StreamPipes enables flexible modeling of stream processing pipelines by providing a graphical -modeling editor on top of existing stream processing frameworks. - -It empowers non-technical users to quickly define and execute processing pipelines based on an easily extensible -toolbox of data sources, data processors and data sinks. StreamPipes has an exchangeable runtime execution layer and -executes pipelines using one of the provided wrappers, e.g., standalone or distributed in Apache Flink. - -Pipeline elements in StreamPipes can be installed at runtime - the built-in SDK allows to easily implement new -pipeline elements according to your needs. Pipeline elements are standalone microservices that can run anywhere - -centrally on your server, in a large-scale cluster or close at the edge. - -* StreamPipes core repository: [https://github.com/apache/streampipes](https://github.com/apache/streampipes) -* Website: [https://streampipes.apache.org/](https://streampipes.apache.org/) -* Docs: [https://streampipes.apache.org/docs](https://streampipes.apache.org/docs) - -### Extensions: Connect Adapters and Pipeline Elements - -This project provides a library of several Connect adapters and pipeline elements that can be used within the Apache StreamPipes toolbox. - -See [https://streampipes.apache.org/docs/docs/pipeline-elements/](https://streampipes.apache.org/docs/docs/pipeline-elements/) -for an overview of currently available pipeline elements. - -Contact us if you are missing some pipeline elements! - -### Installation - -The quickest way to run StreamPipes including the latest extensions (adapters, pipeline elements) is by using our Docker-based [installation & operation options](https://www.github.com/apache/streampipes-installer), namely: - -* **[StreamPipes Compose](https://github.com/apache/streampipes-installer/compose)** - The User's Choice -* **[StreamPipes CLI](https://github.com/apache/streampipes-installer/cli)** - The Developer's Favorite -* **[StreamPipes k8s](https://github.com/apache/streampipes-installer/k8s)** - The Operator's Dream - -> **NOTE**: 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. - -For a more in-depth manual, read the installation guide at [https://streampipes.apache.org/docs/docs/try-installation.html](https://streampipes.apache.org/docs/docs/try-installation.html)! - -## Building StreamPipes Extensions -To properly build the StreamPipes extensions project, the following tools should be installed: - -### Prerequisites -* Java 8 JDK (minimum) -* Maven (tested with 3.6) -* NodeJS + NPM (tested with v12+/ v6+) -* Docker + Docker-Compose - -### Building - -To build the extensions project, do the following: - -``` - mvn clean package -``` - -### Starting - -To start StreamPipes Extensions, run ``docker-compose up -d`` from the root directory. Make sure the core (streampipes) is already started. - -You can also use the installer or CLI as described in the ``Getting Started`` section. - - -## Bugs and Feature Requests - -If you've found a bug or have a feature that you'd love to see in StreamPipes, feel free to create an issue on [GitHub](https://github.com/apache/streampipes/issues) -or start a [discussion](https://github.com/apache/streampipes/discussions). - -## Get help - -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) - -And don't forget to follow us on [Twitter](https://twitter.com/streampipes)! - -## Contribute - -We welcome contributions to StreamPipes. If you are interested in contributing to StreamPipes, let us know! You'll - get to know an open-minded and motivated team working together to build the next IIoT analytics toolbox. - -Here are some first steps in case you want to contribute: -* Subscribe to our dev mailing list [[email protected]]([email protected]) -* Send an email, tell us about your interests and which parts of Streampipes you'd like to contribute (e.g., core or UI)! -* Ask for a mentor who helps you to understand the code base and guides you through the first setup steps -* Find an issue on [GitHub](https://github.com/apache/streampipes/issues) which is tagged with a _good first issue_ tag -* Have a look at our developer wiki at [https://cwiki.apache.org/confluence/display/STREAMPIPES/Home](https://cwiki.apache.org/confluence/display/STREAMPIPES/Home) to learn more about StreamPipes development. - -Have fun! -
