You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by wi...@apache.org on 2020/08/21 08:00:51 UTC
[incubator-streampipes-installer] branch dev updated:
[STREAMPIPES-196] some minor changes to cli README,
add link to jira to all README
This is an automated email from the ASF dual-hosted git repository.
wiener pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-installer.git
The following commit(s) were added to refs/heads/dev by this push:
new fdb0bbe [STREAMPIPES-196] some minor changes to cli README, add link to jira to all README
fdb0bbe is described below
commit fdb0bbe6d6dab16687d48c36f6260286d08ab374
Author: Patrick Wiener <wi...@fzi.de>
AuthorDate: Fri Aug 21 09:59:18 2020 +0200
[STREAMPIPES-196] some minor changes to cli README, add link to jira to all README
---
README.md | 5 +++++
cli/README.md | 13 +++++++++----
compose/README.md | 5 +++++
k8s/README.md | 5 +++++
4 files changed, 24 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 3279204..ff82adb 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,11 @@ To upgrade the StreamPipes version all at once for all options and README files
./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 in our Jira:
+[https://issues.apache.org/jira/projects/STREAMPIPES](https://issues.apache.org/jira/projects/STREAMPIPES)
+
## Get help
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:
diff --git a/cli/README.md b/cli/README.md
index ca1be39..0ff0700 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -165,7 +165,7 @@ As of now, this step has to be done **manually**. All environment templates are
├── pipeline-element # developing new pipeline-elements
└── ui # developing UI features
```
-**Modifying an existing template**. To modify an existing template, you can simply add a `<YOUR_NEW_SERVICE>` to the template.
+**Modifying an existing environment template**. To modify an existing template, you can simply add a `<YOUR_NEW_SERVICE>` to the template.
> **NOTE**: You need to make sure, that the service your are adding exists in `deploy/standalone/service/<YOUR_NEW_SERVICE>`. If your're adding a completely new service take a look at existing ones, create a new service directory and include a `docker-compose.yml` and `docker-compose.dev.yml` file.
```
@@ -176,11 +176,11 @@ kafka
<YOUR_NEW_SERVICE>
```
-**Creating a new** template. To create a new template, place a new file `bin/templates/environments/<YOUR_NEW_TEMPLATE>` in the template directory. Open the file and use the following schema.
-> **IMPORTANT**: Please make sure to have `[environment:<YOUR_NEW_TEMPLATE>]` header in the first line of your new template matching the name of the file. Make sure to use small caps letters (lowercase) only.
+**Creating a new** environment template. To create a new environment template, place a new file `bin/templates/environments/<YOUR_NEW_ENVIRONMENT>` in the template directory. Open the file and use the following schema.
+> **IMPORTANT**: Please make sure to have `[environment:<YOUR_NEW_ENVIRONMENT>]` header in the first line of your new template matching the name of the file. Make sure to use small caps letters (lowercase) only.
```
-[environment:<YOUR_NEW_TEMPLATE>]
+[environment:<YOUR_NEW_ENVIRONMENT>]
<SERVICE_1>
<SERVICE_2>
...
@@ -201,6 +201,11 @@ For **Windows 10**, e.g. check this [documentation](https://helpdeskgeek.com/win
## Upgrade to new version
To upgrade to a new version, simply edit the version tag in `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 in our Jira:
+[https://issues.apache.org/jira/projects/STREAMPIPES](https://issues.apache.org/jira/projects/STREAMPIPES)
+
## Get help
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:
diff --git a/compose/README.md b/compose/README.md
index 309a62a..92c3da3 100644
--- a/compose/README.md
+++ b/compose/README.md
@@ -85,6 +85,11 @@ To upgrade to another StreamPipes version, simply edit the `SP_VERSION` in the `
SP_VERSION=<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 in our Jira:
+[https://issues.apache.org/jira/projects/STREAMPIPES](https://issues.apache.org/jira/projects/STREAMPIPES)
+
## Get help
Since we purely levarage Docker Compose, please see their [documentation](https://docs.docker.com/compose/) in case you want to find out more about their available [commands](https://docs.docker.com/compose/reference/overview/).
diff --git a/k8s/README.md b/k8s/README.md
index d7bb65e..f7586c6 100644
--- a/k8s/README.md
+++ b/k8s/README.md
@@ -46,6 +46,11 @@ helm install streampipes ./ --set deployment=full
helm del streampipes
```
+## 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 in our Jira:
+[https://issues.apache.org/jira/projects/STREAMPIPES](https://issues.apache.org/jira/projects/STREAMPIPES)
+
## Get help
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels: