You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by rm...@apache.org on 2019/06/21 14:36:37 UTC
[flink-web] 02/08: [FLINK-12605] Add contributing/ directory
This is an automated email from the ASF dual-hosted git repository.
rmetzger pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
commit 6aae7c899dd236591072c2ead51a1d39186242f6
Author: Robert Metzger <rm...@apache.org>
AuthorDate: Mon May 20 14:59:11 2019 +0200
[FLINK-12605] Add contributing/ directory
---
_includes/navbar.html | 8 +++++++-
contribute-code.md => contributing/contribute-code.md | 2 +-
contribute-code.zh.md => contributing/contribute-code.zh.md | 0
.../contribute-documentation.md | 0
.../contribute-documentation.zh.md | 0
contributing/contribute-jira-and-processes.md | 5 +++++
how-to-contribute.md => contributing/how-to-contribute.md | 12 ++++++------
.../how-to-contribute.zh.md | 0
improve-website.md => contributing/improve-website.md | 0
improve-website.zh.md => contributing/improve-website.zh.md | 0
reviewing-prs.md => contributing/reviewing-prs.md | 0
reviewing-prs.zh.md => contributing/reviewing-prs.zh.md | 0
12 files changed, 19 insertions(+), 8 deletions(-)
diff --git a/_includes/navbar.html b/_includes/navbar.html
index 4df5db7..5cc1242 100755
--- a/_includes/navbar.html
+++ b/_includes/navbar.html
@@ -80,7 +80,13 @@
<li{% if page.url contains '/roadmap.html' %} class="active"{% endif %}><a href="{{ baseurl_i18n }}/roadmap.html">{{ site.data.i18n[page.language].roadmap }}</a></li>
<!-- Contribute -->
- <li{% if page.url contains '/how-to-contribute.html' %} class="active"{% endif %}><a href="{{ baseurl_i18n }}/how-to-contribute.html">{{ site.data.i18n[page.language].how_to_contribute }}</a></li>
+ <li{% if page.url contains '/contributing/how-to-contribute.html' %} class="active"{% endif %}><a href="{{ baseurl_i18n }}/contributing/how-to-contribute.html">{{ site.data.i18n[page.language].how_to_contribute }}</a></li>
+ {% if page.url contains '/contributing/' %}
+ <ul style="margin-left: 0px;list-style: none;font-weight: bold;">
+ <li>Contribute Code</li>
+ <li>Review Code</li>
+ </ul>
+ {% endif %}
<!-- GitHub -->
<li>
diff --git a/contribute-code.md b/contributing/contribute-code.md
similarity index 99%
rename from contribute-code.md
rename to contributing/contribute-code.md
index feb22cc..5d1ddd7 100644
--- a/contribute-code.md
+++ b/contributing/contribute-code.md
@@ -106,7 +106,7 @@ Only committers have the permission to assign somebody.
Code changes in Flink are reviewed and accepted through [GitHub pull requests](https://help.github.com/en/articles/creating-a-pull-request).
-There is a separate guide on [how to review a pull request]({{ site.base }}/reviewing-prs.html), including our pull request review process. As a code author, you should prepare your pull request to meet all requirements.
+There is a separate guide on [how to review a pull request]({{ site.base }}/contributing/reviewing-prs.html), including our pull request review process. As a code author, you should prepare your pull request to meet all requirements.
Considerations before opening a pull request:
diff --git a/contribute-code.zh.md b/contributing/contribute-code.zh.md
similarity index 100%
rename from contribute-code.zh.md
rename to contributing/contribute-code.zh.md
diff --git a/contribute-documentation.md b/contributing/contribute-documentation.md
similarity index 100%
rename from contribute-documentation.md
rename to contributing/contribute-documentation.md
diff --git a/contribute-documentation.zh.md b/contributing/contribute-documentation.zh.md
similarity index 100%
rename from contribute-documentation.zh.md
rename to contributing/contribute-documentation.zh.md
diff --git a/contributing/contribute-jira-and-processes.md b/contributing/contribute-jira-and-processes.md
new file mode 100644
index 0000000..acc8619
--- /dev/null
+++ b/contributing/contribute-jira-and-processes.md
@@ -0,0 +1,5 @@
+---
+title: "Jira and Processes in Flink"
+---
+
+How is Flink using Jira?
diff --git a/how-to-contribute.md b/contributing/how-to-contribute.md
similarity index 94%
rename from how-to-contribute.md
rename to contributing/how-to-contribute.md
index 1475de7..eaa5e0c 100644
--- a/how-to-contribute.md
+++ b/contributing/how-to-contribute.md
@@ -21,11 +21,11 @@ Apache Flink is developed by an open and friendly community. Everybody is cordia
<tbody>
<tr>
<td><span class="glyphicon glyphicon-console" aria-hidden="true"></span> Contribute Code</td>
- <td>Read the <a href="{{ site.baseurl }}/contribute-code.html">Code Contribution Guide</a></td>
+ <td>Read the <a href="{{ site.baseurl }}/contributing/contribute-code.html">Code Contribution Guide</a></td>
</tr>
<tr>
<td><span class="glyphicon glyphicon-ok" aria-hidden="true"></span> Help With Code Reviews</td>
- <td>Read the <a href="{{ site.baseurl }}/reviewing-prs.html">Code Review Guide</a></td>
+ <td>Read the <a href="{{ site.baseurl }}/contributing/reviewing-prs.html">Code Review Guide</a></td>
</tr>
<tr>
<td><span class="glyphicon glyphicon-thumbs-up" aria-hidden="true"></span> Review a Release Candidate</td>
@@ -41,7 +41,7 @@ Apache Flink is developed by an open and friendly community. Everybody is cordia
</tr>
<tr>
<td><span class="glyphicon glyphicon-list-alt" aria-hidden="true"></span> Contribute Documentation</td>
- <td>Read the <a href="{{ site.baseurl }}/contribute-documentation.html">Documentation Contribution Guide</a></td>
+ <td>Read the <a href="{{ site.baseurl }}/contributing/contribute-documentation.html">Documentation Contribution Guide</a></td>
</tr>
<tr>
<td><span class="glyphicon glyphicon-user" aria-hidden="true"></span> Support Flink Users</td>
@@ -55,7 +55,7 @@ Apache Flink is developed by an open and friendly community. Everybody is cordia
</tr>
<tr>
<td><span class="glyphicon glyphicon-blackboard" aria-hidden="true"></span> Contribute To The Website</td>
- <td>Read the <a href="{{ site.baseurl }}/improve-website.html">Website Contribution Guide</a></td>
+ <td>Read the <a href="{{ site.baseurl }}/contributing/improve-website.html">Website Contribution Guide</a></td>
</tr>
<tr>
<td><span class="glyphicon glyphicon-volume-up" aria-hidden="true"></span> Contribute Evangelism</td>
@@ -69,7 +69,7 @@ Apache Flink is developed by an open and friendly community. Everybody is cordia
</tr>
<tr>
<td colspan="2">
- <span class="glyphicon glyphicon-question-sign" aria-hidden="true"></span> Any other question? Reach out to the <a href="https://flink.apache.org/community.html#mailing-lists">community@flink.apache.org mailing list</a> to get help!
+ <span class="glyphicon glyphicon-question-sign" aria-hidden="true"></span> Any other question? Reach out to the <a href="https://flink.apache.org/community.html#mailing-lists">dev@flink.apache.org mailing list</a> to get help!
</td>
</tr>
</tbody>
@@ -86,7 +86,7 @@ Our community is constantly looking for feedback to improve Apache Flink. If you
- It helps to estimate the effort and to design a solution that addresses your needs.
- It allow for constructive discussions that might arise around this issue.
-Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the [Contribute code]({{ site.base }}/contribute-code.html) guide in this case as well.
+Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the [Contribute code]({{ site.base }}/contributing/contribute-code.html) guide in this case as well.
We recommend to first reach consensus with the community on whether a new feature is required and how to implement a new feature, before starting with the implementation. Some features might be out of scope of the project, and it's best to discover this early.
diff --git a/how-to-contribute.zh.md b/contributing/how-to-contribute.zh.md
similarity index 100%
rename from how-to-contribute.zh.md
rename to contributing/how-to-contribute.zh.md
diff --git a/improve-website.md b/contributing/improve-website.md
similarity index 100%
rename from improve-website.md
rename to contributing/improve-website.md
diff --git a/improve-website.zh.md b/contributing/improve-website.zh.md
similarity index 100%
rename from improve-website.zh.md
rename to contributing/improve-website.zh.md
diff --git a/reviewing-prs.md b/contributing/reviewing-prs.md
similarity index 100%
rename from reviewing-prs.md
rename to contributing/reviewing-prs.md
diff --git a/reviewing-prs.zh.md b/contributing/reviewing-prs.zh.md
similarity index 100%
rename from reviewing-prs.zh.md
rename to contributing/reviewing-prs.zh.md