You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wayang.apache.org by rp...@apache.org on 2021/09/14 21:51:33 UTC
[incubator-wayang] 01/01: [RELEASE][PREPARATION] General
documentation about how to contribute
This is an automated email from the ASF dual-hosted git repository.
rpardomeza pushed a commit to branch docs-contribute
in repository https://gitbox.apache.org/repos/asf/incubator-wayang.git
commit 5de053d3a48584bfac9e029713d76057b45b732f
Author: rodrigopardomeza <ro...@gmail.com>
AuthorDate: Tue Sep 14 23:50:57 2021 +0200
[RELEASE][PREPARATION] General documentation about how to contribute
---
wayang-docs/src/main/resources/Gemfile.lock | 3 +-
wayang-docs/src/main/resources/_data/menus.yml | 116 ++++++++++-----------
.../main/resources/how_contribute/bugs_report.md | 7 +-
.../pull_request.md | 24 ++++-
.../main/resources/how_contribute/helping_users.md | 2 +-
.../how_contribute/jira_issue_maintenance.md | 18 +++-
.../resources/how_contribute/slack_channels.md | 3 +-
7 files changed, 106 insertions(+), 67 deletions(-)
diff --git a/wayang-docs/src/main/resources/Gemfile.lock b/wayang-docs/src/main/resources/Gemfile.lock
index 433ff60..b592def 100644
--- a/wayang-docs/src/main/resources/Gemfile.lock
+++ b/wayang-docs/src/main/resources/Gemfile.lock
@@ -68,6 +68,7 @@ GEM
unicode-display_width (1.7.0)
PLATFORMS
+ universal-darwin-19
universal-darwin-20
universal-java-1.8
@@ -78,4 +79,4 @@ DEPENDENCIES
jekyll-menus
BUNDLED WITH
- 2.2.14
+ 2.2.27
diff --git a/wayang-docs/src/main/resources/_data/menus.yml b/wayang-docs/src/main/resources/_data/menus.yml
index c684d4c..f5335f3 100644
--- a/wayang-docs/src/main/resources/_data/menus.yml
+++ b/wayang-docs/src/main/resources/_data/menus.yml
@@ -13,25 +13,25 @@
# See the License for the specific language governing permissions and
# limitations under the License.
header:
- - url: /what_is_wayang/
- title: What is Wayang?
- identifier: what_wayang
- weight: 1
-
- - url: /getting_start/
- title: Getting Started with Wayang
- identifier: getting_start
- weight: 2
-
- - url: /using_wayang/
- title: Using Wayang
- identifier: using
- weight: 3
+# - url: /what_is_wayang/
+# title: What is Wayang?
+# identifier: what_wayang
+# weight: 1
+
+# - url: /getting_start/
+# title: Getting Started with Wayang
+# identifier: getting_start
+# weight: 2
+
+# - url: /using_wayang/
+# title: Using Wayang
+# identifier: using
+# weight: 3
- - url: /extending_wayang/
- title: Extending Wayang
- identifier: extending
- weight: 4
+# - url: /extending_wayang/
+# title: Extending Wayang
+# identifier: extending
+# weight: 4
- url: /how_contribute/
title: How To Contribute
@@ -39,53 +39,53 @@ header:
weight: 5
-getting_start:
- - url: /getting_start/how_build/
- title: How To Build Wayang
- identifier: build
- weight: 0
-
- - url: /getting_start/how_install/
- title: How To Install Wayang
- identifier: install
- weight: 1
-
- - url: /getting_start/how_run/
- title: How To Run Wayang
- identifier: run
- weight: 2
-
- - url: /getting_start/writting_wayang_plan/
- title: Writting a Wayang Plan
- identifier: writting
- weight: 3
-
-using:
- - url: /using_wayang/api_java_scala/
- title: API Java/Scala
- identifier: api_java
- weight: 0
-
- - url: /using_wayang/api_python/
- title: API Python
- identifier: api_python
- weight: 1
+#getting_start:
+# - url: /getting_start/how_build/
+# title: How To Build Wayang
+# identifier: build
+# weight: 0
+#
+# - url: /getting_start/how_install/
+# title: How To Install Wayang
+# identifier: install
+# weight: 1
+#
+# - url: /getting_start/how_run/
+# title: How To Run Wayang
+# identifier: run
+# weight: 2
+#
+# - url: /getting_start/writting_wayang_plan/
+# title: Writting a Wayang Plan
+# identifier: writting
+# weight: 3
- - url: /using_wayang/api_rest/
- title: API REST
- identifier: api_rest
- weight: 2
+#using:
+# - url: /using_wayang/api_java_scala/
+# title: API Java/Scala
+# identifier: api_java
+# weight: 0
+#
+# - url: /using_wayang/api_python/
+# title: API Python
+# identifier: api_python
+# weight: 1
+#
+# - url: /using_wayang/api_rest/
+# title: API REST
+# identifier: api_rest
+# weight: 2
# - url: /using_wayang/api_sql/
# title: API SQL
# identifier: api_sql
# weight: 3
-extending:
- - url: /extending_wayang/adding_platform/
- title: Adding Platform
- identifier: platform
- weight: 0
+#extending:
+# - url: /extending_wayang/adding_platform/
+# title: Adding Platform
+# identifier: platform
+# weight: 0
contribute:
- url: /how_contribute/code_changes/
diff --git a/wayang-docs/src/main/resources/how_contribute/bugs_report.md b/wayang-docs/src/main/resources/how_contribute/bugs_report.md
index 32117ff..d3bd5e7 100644
--- a/wayang-docs/src/main/resources/how_contribute/bugs_report.md
+++ b/wayang-docs/src/main/resources/how_contribute/bugs_report.md
@@ -47,4 +47,9 @@ It is possible to propose new features as well. These are generally not helpful
### Label meaning
-TODO: add the label meaning
+Description of error types:
+
+* Functional error: It is a Generic error type that requires further analysis. Happens whenever software does not behave as intended. For example, if the end user clicks the “Save” button, but their entered data isn’t saved, this is a functional error.
+* Logic error: The error represents a mistake in the software flow and causes the software to behave incorrectly. This type of error can cause the program to produce an incorrect output, or even hang or crash.
+* Calculation error: Anytime software returns an incorrect value. There may be used an incorrect algorithm or a data type mismatch during arithmetic operations.
+* Out of bounds error: End user interacts with the software in ways that were not expected. This often occurs when the user sets a parameter outside the limits of intended use.
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/pull_request.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/pull_request.md
index 37f4b5d..b3b253b 100644
--- a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/pull_request.md
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/pull_request.md
@@ -29,4 +29,26 @@ menus:
# Pull Request
-TODO: add this
+The simplest way to submit code changes, is via a GitHub pull-request.
+
+In order to do this first create a GitHub account and sign into you account.
+
+After that’s done, please visit our GitHub site and create a so-called Fork.
+
+
+
+What happens now, is that GitHub creates a full copy of the Wayang repository in your account. Only you can commit to this.
+
+Now ideally you check-out your cloned repository:
+
+* git clone https://github.com/{your-user-id}/incubator-wayang.git
+
+Now you have a copy of Wayang on your computer and you can change whatever you want and as it’s your copy, you can even commit these changes without any danger of breaking things.
+
+As soon as you’re finished with your changes and want us to have a look, it’s time to create a so-called Pull-Request.
+
+You do that by going to your forked repository page on GitHub.
+
+Every forked repository has an additional button called "New Pull Request":
+
+If you click on it, we will receive a notification on your changes and can review them. We also can discuss your changes and have you perfect your pull request before we accept and merge it into Wayang.
\ No newline at end of file
diff --git a/wayang-docs/src/main/resources/how_contribute/helping_users.md b/wayang-docs/src/main/resources/how_contribute/helping_users.md
index b7adfb8..38e9454 100644
--- a/wayang-docs/src/main/resources/how_contribute/helping_users.md
+++ b/wayang-docs/src/main/resources/how_contribute/helping_users.md
@@ -29,7 +29,7 @@ menus:
# Helping Other Users
-A great way to contribute to Wayang is to help answer user questions on the StackOverflow. There are always many new Wayang users; taking a few minutes to help answer a question is a very valuable community service.
+A great way to contribute to Wayang is to help answer user questions on StackOverflow. There are always many new Wayang users; taking a few minutes to help answer a question is a very valuable community service.
Contributors should subscribe to email list (`dev@wayang.apache.org`) and follow it in order to keep up to date on what’s happening in Wayang. Answering questions is an excellent and visible way to help the community, which also demonstrates your expertise.
diff --git a/wayang-docs/src/main/resources/how_contribute/jira_issue_maintenance.md b/wayang-docs/src/main/resources/how_contribute/jira_issue_maintenance.md
index fda271f..16f2d4c 100644
--- a/wayang-docs/src/main/resources/how_contribute/jira_issue_maintenance.md
+++ b/wayang-docs/src/main/resources/how_contribute/jira_issue_maintenance.md
@@ -48,9 +48,19 @@ When resolving [Issue](https://issues.apache.org/jira/projects/WAYANG/issues), o
## Types of Label of the Issues
-TODO: complete this part
-* Bug:
-* Feature Request:
-* Suggestion:
+* Change : Requesting a change in the current IT profile.
+* IT help: Requesting help for an IT related problem.
+
+* Incident: Reporting an incident or IT service outage.
+
+* New feature: Requesting new capability or software feature.
+
+* Problem: Investigating and reporting the root cause of multiple incidents.
+
+* Service request: Requesting help from an internal or customer service team.
+
+* Service request with approval: Requesting help that requires a manager or board approval.
+
+* Support: Requesting help for customer support issues.
\ No newline at end of file
diff --git a/wayang-docs/src/main/resources/how_contribute/slack_channels.md b/wayang-docs/src/main/resources/how_contribute/slack_channels.md
index 8af8fb8..9e90824 100644
--- a/wayang-docs/src/main/resources/how_contribute/slack_channels.md
+++ b/wayang-docs/src/main/resources/how_contribute/slack_channels.md
@@ -26,6 +26,7 @@ menus:
# Slack Channels
-TODO: analyse if is necessary to do it
+In case of any doubts, our community will be glad to answer your questions.
+Join the Apache Wayang slack. After creating account in slack you can join #wayang where you can look for help in using and developing Apache Wayang.