You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2022/11/26 10:17:05 UTC
[streampipes] branch chore/issue-templates created (now 4fd00c734)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a change to branch chore/issue-templates
in repository https://gitbox.apache.org/repos/asf/streampipes.git
at 4fd00c734 create template for documentation and website
This branch includes the following new commits:
new 1c3d9618b create template for documentation and website
new 4fd00c734 create template for documentation and website
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[streampipes] 01/02: create template for documentation and website
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/issue-templates
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 1c3d9618b8688cd51b519398381de1f0faa65f2c
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Nov 26 11:00:43 2022 +0100
create template for documentation and website
---
.github/ISSUE_TEMPLATE/config.yml | 24 ++++++
.../ISSUE_TEMPLATE/doc_website_issue_report.yml | 89 ++++++++++++++++++++++
2 files changed, 113 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..54397d71c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,24 @@
+# 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.
+
+---
+blank_issues_enabled: false
+contact_links:
+ - name: Ask a question or get support
+ url: https://github.com/apache/streampipes/discussions/categories/q-a
+ about: Ask a question or request support for using Apache StreamPipes
+ - name: Questions on Stack Overflow
+ url: https://stackoverflow.com/questions/tagged/streampipes
+ about: Look at questions/answers at Stack Overflow
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml b/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml
new file mode 100644
index 000000000..0ed87db81
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml
@@ -0,0 +1,89 @@
+# 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.
+
+---
+name: StreamPipes Documentation/Website issue report
+description: Problems and issues with Apache StreamPipes documentation or website
+labels: ["bug", "documentation", "website"]
+body:
+ - type: markdown
+ attributes:
+ value: "
+
+ <img src='https://streampipes.apache.org/img/sp-logo-color.png' alt='StreamPipes Logo' title='Apache StreamPipes Logo' width='50%' align='center'/>
+
+ <br>
+
+ Thank you for taking the time to report the issue!
+
+ We greatly appreciate the community's efforts to improve StreamPipes.
+
+ Please note that you do not need to create an issue if you want to submit a change!
+
+ You can open a [pull request](https://github.com/apache/streampipes/pulls) immediately instead.
+ "
+
+ - type: dropdown
+ attributes:
+ label: Where does your observation occur?
+ description: Please choose whether the issue you want to report occurs on the [website](https://streampipes.apache.org/) or on the [documentation](https://streampipes.apache.org/docs/index.html).
+ multiple: false
+ options:
+ - StreamPipes Documentation
+ - StreamPipes Website
+
+ - type: textarea
+ attributes:
+ label: What do you want to report?
+ description: Please describe the issue you have observed.
+ placeholder: >
+ Please include links to the part of the documentation/website that has the problem and possibly screenshots (or even GIFs) showing
+ the problem. Explain why do you think it is an issue.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Solving the problem
+ description: Do you already have an idea how this could be solved?
+ placeholder: >
+ Please explain how you think the documentation/website could be improved.
+ Ideally, indicate where new or missing descriptions should be added and what type of information should be included.
+ Sometimes the authors are not aware that some assumptions they have are not in the minds of the readers.
+ Therefore, try to explain exactly what you want to see in the documentation/website and why (if applicable).
+ - type: textarea
+ attributes:
+ label: Anything left
+ description: Is there anything left you would like to add?
+ placeholder: >
+ How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
+ How urgent do you think it is that the problem be fixed?
+ How did you stumble upon the problem?
+ Is there any contextual information that you think is valuable?
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ description: >
+ This is absolutely not required, but we will be happy to help you write the post especially if
+ you already have a good understanding of how to implement the fix.
+ StreamPipes is a community-driven project and we welcome new contributors.
+ Find us [here](https://github.com/apache/streampipes/discussions/categories/q-a) or contact us on our mailing list (dev@streampipes.apache.org).
+ options:
+ - label: Yes I am willing to submit a PR!
+
+ - type: markdown
+ attributes:
+ value: "pray: Thanks a lot for completing our form!"
[streampipes] 02/02: create template for documentation and website
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/issue-templates
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 4fd00c7348be233e3261c67bd7ea98346d3cfd68
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Nov 26 11:16:14 2022 +0100
create template for documentation and website
---
.github/ISSUE_TEMPLATE/doc_website_issue_report.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml b/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml
index 0ed87db81..92778b72e 100644
--- a/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml
+++ b/.github/ISSUE_TEMPLATE/doc_website_issue_report.yml
@@ -21,6 +21,7 @@ body:
- type: markdown
attributes:
value: "
+ <p align='center'>
<img src='https://streampipes.apache.org/img/sp-logo-color.png' alt='StreamPipes Logo' title='Apache StreamPipes Logo' width='50%' align='center'/>
@@ -33,6 +34,7 @@ body:
Please note that you do not need to create an issue if you want to submit a change!
You can open a [pull request](https://github.com/apache/streampipes/pulls) immediately instead.
+ </p>
"
- type: dropdown