Merge pull request #14 from berttty/docs
Docs
diff --git a/.travis.yml b/.travis.yml
index 4fd978f..419abde 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -63,7 +63,7 @@
- rm -rf /home/travis/build/apache/incubator-wayang/target/rat.txt || echo "file doesn't exist"
- rm -rf result.log || echo "file doesn't exist"
- mvn_opts=("-Dorg.slf4j.simpleLogger.defaultLogLevel=error" "-Dwayang.configuration=file://$(pwd)/travis/wayang.properties" "-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=error" "-Dlog4j.rootLogger=ERROR")
- - chmod +x ./docs/script/cibuild
+# - chmod +x ./docs/script/cibuild
script:
#- jdk_switcher use openjdk8
- bin/change-scala-version.sh 2.11.8 && mvn clean install -Pdistro "${mvn_opts[@]}" &> result.log
diff --git a/wayang-docs/pom.xml b/wayang-docs/pom.xml
index e5fc024..8548dca 100644
--- a/wayang-docs/pom.xml
+++ b/wayang-docs/pom.xml
@@ -32,7 +32,6 @@
<properties>
<github.global.server>github</github.global.server>
- <github.site.userName>berttty</github.site.userName>
</properties>
<build>
diff --git a/wayang-docs/src/main/resources/Gemfile b/wayang-docs/src/main/resources/Gemfile
index e437622..d674407 100644
--- a/wayang-docs/src/main/resources/Gemfile
+++ b/wayang-docs/src/main/resources/Gemfile
@@ -28,6 +28,7 @@
group :jekyll_plugins do
gem 'jekyll-asciidoc', '~> 2.1.1'
+ gem "jekyll-menus"
end
#gem "html-proofer"
diff --git a/wayang-docs/src/main/resources/README.md b/wayang-docs/src/main/resources/README.md
new file mode 100644
index 0000000..ac91bc6
--- /dev/null
+++ b/wayang-docs/src/main/resources/README.md
@@ -0,0 +1,4 @@
+# NOTES:
+
+## menus
+the menus is using the plugin jekyll-menus, the documentation is [here](https://github.com/forestryio/jekyll-menus)
diff --git a/wayang-docs/src/main/resources/_config.yml b/wayang-docs/src/main/resources/_config.yml
index e4058a5..ab158eb 100644
--- a/wayang-docs/src/main/resources/_config.yml
+++ b/wayang-docs/src/main/resources/_config.yml
@@ -39,3 +39,6 @@
blanklines: false
profile: true
startings: [html, head, body]
+plugins:
+ - jekyll-menus
+exclude: ['README.md', 'Gemfile.lock', 'Gemfile']
diff --git a/wayang-docs/src/main/resources/_data/menus.yml b/wayang-docs/src/main/resources/_data/menus.yml
new file mode 100644
index 0000000..abf81e4
--- /dev/null
+++ b/wayang-docs/src/main/resources/_data/menus.yml
@@ -0,0 +1,35 @@
+header:
+ - url: /how_contribute/
+ title: How To Contribute
+ identifier: contribute
+ weight: 1
+
+ - url: /how_build/
+ title: How To Build Wayang
+ identifier: build
+ weight: 2
+
+ - url: /how_install/
+ title: How To Install Wayang
+ identifier: install
+ weight: 3
+
+ - url: /how_run/
+ title: How To Run Wayang
+ identifier: run
+ weight: 4
+
+contribute:
+ - url: /how_contribute/code_changes/
+ title: Code Changes
+ identifier: code_changes
+ weight: 4
+
+
+code_changes:
+ - url: /how_contribute/code_changes/preparing_contribute_code_changes/
+ title: Preparing to Contribute Code Changes
+ identifier: preparing_code_changes
+ weight: 5
+
+
diff --git a/wayang-docs/src/main/resources/_data/navigation.yml b/wayang-docs/src/main/resources/_data/navigation.yml
deleted file mode 100644
index 1af20c6..0000000
--- a/wayang-docs/src/main/resources/_data/navigation.yml
+++ /dev/null
@@ -1,51 +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.
-#
-
-- title: Home
- url: /
- external: false
-
-- title: About
- url: /about
- external: false
-
-- title: Community
- url: /community
- external: false
-
-- title: Documentation
- url: /documentation
- external: false
-
-- title: Publications
- url: /publications-home
- external: false
-
-- title: Apache
- sublinks:
- - title: Apache Software Foundation
- url: http://www.apache.org/foundation/how-it-works.html
- external: true
- - title: Apache License
- url: http://www.apache.org/licenses/
- external: true
- - title: Sponsorship
- url: http://www.apache.org/foundation/sponsorship.html
- external: true
- - title: Thanks
- url: http://www.apache.org/foundation/thanks.html
- external: true
diff --git a/wayang-docs/src/main/resources/_includes/header.html b/wayang-docs/src/main/resources/_includes/header.html
deleted file mode 100644
index fa015e3..0000000
--- a/wayang-docs/src/main/resources/_includes/header.html
+++ /dev/null
@@ -1,85 +0,0 @@
-{% comment %}
- 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.
-{% endcomment %}
-
-{% comment %} capture the current page {% endcomment %}
-{% for entry in site.data.navigation %}
- {% capture fullurl %}{{ entry.url | absolute_url }}{% endcapture %}
- {% if fullurl == page.url %}
- {% assign current_page = fullurl %}
- {% break %}
- {% elsif page.url contains fullurl %}
- {% assign current_page = fullurl %}
- {% endif %}
-{% endfor %}
-
-<nav class="navbar navbar-expand-lg navbar-light bg-light sticky-top shadow-lg">
- <div class="container d-flex justify-content-between w-100">
- <div class="mr-auto p-2 w-100">
- <div class="d-flex">
- <a class="navbar-brand mr-auto" href="{% link index.md %}">
- <img style="max-height: 75px" src="{{ "assets/img/logo/logo_400x160.png" | absolute_url }}"/>
- </a>
- <button class="navbar-toggler ml-auto align-self-center" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
- </div>
-
- </div>
-
- <div>
- <div class="p-2 collapse navbar-collapse" id="navbarSupportedContent">
- <div class="navbar-nav">
- {% for entry in site.data.navigation %}
- {% if entry.url == current_page %}
- {% assign current = 'active' %}
- {% else %}
- {% assign current = '' %}
- {% endif %}
-
- {% assign sublinks = entry.sublinks %}
- {% if sublinks %}
- <li class="nav-item dropdown {{current}}">
- <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
- {{ entry.title }}
- </a>
- <div class="dropdown-menu">
- {% for sublink in sublinks %}
- <a class="dropdown-item" href="{{ sublink.url | absolute_url }}">
- {{ sublink.title }}
- </a>
- {% endfor %}
- </div>
- </li>
- {% else %}
- <li class="nav-item {{current}}">
- <a class="nav-link" href="{{ entry.url | absolute_url }}">
- {{ entry.title }}
- </a>
- </li>
- {% endif %}
- {% endfor %}
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
-
-</nav>
diff --git a/wayang-docs/src/main/resources/_includes/scripts.html b/wayang-docs/src/main/resources/_includes/scripts.html
index 5bca9ad..e83bcbb 100644
--- a/wayang-docs/src/main/resources/_includes/scripts.html
+++ b/wayang-docs/src/main/resources/_includes/scripts.html
@@ -21,3 +21,4 @@
<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.0/dist/js/bootstrap.bundle.min.js" integrity="sha384-Piv4xVNRyMGpqkS2by6br4gNJ7DXjqk09RmUpJ8jgGtD7zP9yug3goQfGII0yAns" crossorigin="anonymous"></script>
<script src="{{ "assets/js/add_numbers.js" | absolute_url }}"></script>
+<script src="{{ "assets/js/menu.js" | absolute_url }}"></script>
diff --git a/wayang-docs/src/main/resources/_includes/sub-menu.html b/wayang-docs/src/main/resources/_includes/sub-menu.html
new file mode 100644
index 0000000..2ee6ab6
--- /dev/null
+++ b/wayang-docs/src/main/resources/_includes/sub-menu.html
@@ -0,0 +1,58 @@
+{% comment %}
+ 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.
+{% endcomment %}
+
+{% capture itemurl %}{{ item.url | absolute_url }}{% endcapture %}
+{% capture pageurl %}{{ page.url | absolute_url }}{% endcapture %}
+
+{% if itemurl == pageurl %}
+ {% assign current = 'active' %}
+{% else %}
+ {% assign current = '' %}
+{% endif %}
+
+{% capture space %}{{ space | size | times: 0 | plus: 1}}{% endcapture %}
+{% capture hashpath %}{{ item.url | remove: '/' | strip_newlines}}{% endcapture %}
+
+<li class="nav-item">
+ {% unless item.children != nil %}
+ <a class="nav-link {{current}}" href="{{ item.url | absolute_url }}" title="Go to {{ item.title }}">
+ {{ item.title }}
+ </a>
+ {% else %}
+ <div class="d-flex justify-content-between nav-link main-link {{current}}">
+ <a class="p-2" href="{{ item.url | absolute_url }}" title="Go to {{ item.title }}">
+ {{ item.title }}
+ </a>
+ <a class="p-2 align-self-center" data-toggle="collapse" href="#submenu_{{hashpath}}" role="button" aria-expanded="false" aria-controls="submenu_{{hashpath}}">
+ <i class="fas fa-chevron-down"></i>
+ </a>
+ </div>
+ <div class="collapse sub-menu" id="submenu_{{hashpath}}">
+ <ul class="flex-column nav">
+ {% capture level %}{{level}}|{% endcapture %}
+ {% for item in item.children %}
+ {%- include sub-menu.html -%}
+ {% endfor %}
+ {% capture length %}{{ level | size | minus: 1 }}{% endcapture %}
+ {% capture level %}{{ level | slice: 1, length | lstrip | rstrip }}{% endcapture %}
+ </ul>
+ </div>
+ {% endunless %}
+</li>
+
diff --git a/wayang-docs/src/main/resources/_layouts/default.html b/wayang-docs/src/main/resources/_layouts/default.html
index 5a7768a..e3b1e48 100644
--- a/wayang-docs/src/main/resources/_layouts/default.html
+++ b/wayang-docs/src/main/resources/_layouts/default.html
@@ -25,12 +25,12 @@
<header class="navbar navbar-expand flex-column flex-md-row bd-navbar p-0 shadow sticky-top" style=" height: 75px !important; background-color: #ffffff">
- <div class="col-md-3 col-xl-2 text-center">
+ <div class="col-md-3 col-xl-2 text-center"style="border-right: #a00e5a 1px solid; height: 100%">
<a class="navbar-brand mr-auto" href="{% link index.md %}">
<img style="max-height: inherit; height: 2.6em;" src="{{ "assets/img/logo/logo_400x160.png" | absolute_url }}"/>
</a>
</div>
- <div class="col-md-9 col-xl-8" role="main" style="border-left: #a00e5a 1px solid;">
+ <div class="col-md-9 col-xl-8" role="main">
<h3 style="color: #ff8724">Documentation Apache Wayang</h3>
</div>
@@ -39,101 +39,113 @@
<div class="container-fluid">
<div class="row flex-xl-nowrap">
<div class="col-md-3 col-xl-2 bd-sidebar pt-3 px-0" style="min-height: 95vh; border-right: solid 1px #a00e5a; background-color: #F5F7F9">
- <nav class="nav flex-column nav-pills">
- <a class="nav-link active" href="#">Read Me</a>
- <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">How To Contribute</a>
- <a class="nav-link" href="#">Bugs Report</a>
- <a class="nav-link" href="#">Jira Issue Maintenance</a>
- <a class="nav-link" href="#">Documentation Changes</a>
- <a class="nav-link" href="#">Code Changes</a>
- <a class="nav-link" href="#">Code Changes - Choosing What to Contribute</a>
- <a class="nav-link" href="#">Code Changes - Code Review Criteria</a>
- <a class="nav-link" href="#">Code Changes - Preparing to Contribute Code Changes</a>
- <a class="nav-link" href="#">Review Changes</a>
- <a class="nav-link" href="#">Testing Releases</a>
- <a class="nav-link" href="#">User Libraries to Wayang</a>
- <a class="nav-link" href="#">Helping Other Users</a>
- <a class="nav-link" href="#">Slack Channel and Emails</a>
- <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">How To Build Wayang</a>
- <a class="nav-link" href="#">Building Wayang</a>
- <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">How To Install Wayang</a>
- <a class="nav-link" href="#">Installing Wayang</a>
- <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">How To Run Wayang</a>
- <a class="nav-link" href="#">Running Wayang</a>
- </nav>
+ <ul id="main-menu" class="nav flex-column nav-pills">
+ {% for item in site.menus.header | sort:weight %}
+ {%- include sub-menu.html -%}
+ {% endfor %}
+
+ <!-- <a class="nav-link active" href="#">Read Me</a>-->
+<!-- <a class="nav-link main-link" href="how_contribute" tabindex="-1" aria-disabled="true">How To Contribute</a>-->
+<!-- <a class="nav-link" href="how_contribute">Bugs Report</a>-->
+<!-- <a class="nav-link" href="#">Jira Issue Maintenance</a>-->
+<!-- <a class="nav-link" href="#">Documentation Changes</a>-->
+<!-- <a class="nav-link" href="#">Code Changes</a>-->
+<!-- <a class="nav-link" href="#">Code Changes - Choosing What to Contribute</a>-->
+<!-- <a class="nav-link" href="#">Code Changes - Code Review Criteria</a>-->
+<!-- <a class="nav-link" href="#">Code Changes - Preparing to Contribute Code Changes</a>-->
+<!-- <a class="nav-link" href="#">Review Changes</a>-->
+<!-- <a class="nav-link" href="#">Testing Releases</a>-->
+<!-- <a class="nav-link" href="#">User Libraries to Wayang</a>-->
+<!-- <a class="nav-link" href="#">Helping Other Users</a>-->
+<!-- <a class="nav-link" href="#">Slack Channel and Emails</a>-->
+<!-- <a class="nav-link main-link" href="#" tabindex="-1" aria-disabled="true">How To Build Wayang</a>-->
+<!-- <a class="nav-link" href="#">Building Wayang</a>-->
+<!-- <a class="nav-link main-link" href="#" tabindex="-1" aria-disabled="true">How To Install Wayang</a>-->
+<!-- <a class="nav-link" href="#">Installing Wayang</a>-->
+<!-- <a class="nav-link main-link" href="#" tabindex="-1" aria-disabled="true">How To Run Wayang</a>-->
+<!-- <a class="nav-link" href="#">Running Wayang</a>-->
+ </ul>
</div>
<!-- TODO: validate if is usable-->
- <nav class="d-none d-xl-block col-xl-2 bd-toc" aria-label="Secondary navigation">
- <ul class="section-nav">
- <li class="toc-entry toc-h2"><a href="#base-nav">Base nav</a></li>
- <li class="toc-entry toc-h2"><a href="#available-styles">Available styles</a>
- <ul>
- <li class="toc-entry toc-h3"><a href="#horizontal-alignment">Horizontal alignment</a></li>
- <li class="toc-entry toc-h3"><a href="#vertical">Vertical</a></li>
- <li class="toc-entry toc-h3"><a href="#tabs">Tabs</a></li>
- <li class="toc-entry toc-h3"><a href="#pills">Pills</a></li>
- <li class="toc-entry toc-h3"><a href="#fill-and-justify">Fill and justify</a></li>
- </ul>
- </li>
- <li class="toc-entry toc-h2"><a href="#working-with-flex-utilities">Working with flex utilities</a></li>
- <li class="toc-entry toc-h2"><a href="#regarding-accessibility">Regarding accessibility</a></li>
- <li class="toc-entry toc-h2"><a href="#using-dropdowns">Using dropdowns</a>
- <ul>
- <li class="toc-entry toc-h3"><a href="#tabs-with-dropdowns">Tabs with dropdowns</a></li>
- <li class="toc-entry toc-h3"><a href="#pills-with-dropdowns">Pills with dropdowns</a></li>
- </ul>
- </li>
- <li class="toc-entry toc-h2"><a href="#javascript-behavior">JavaScript behavior</a>
- <ul>
- <li class="toc-entry toc-h3"><a href="#using-data-attributes">Using data attributes</a></li>
- <li class="toc-entry toc-h3"><a href="#via-javascript">Via JavaScript</a></li>
- <li class="toc-entry toc-h3"><a href="#fade-effect">Fade effect</a></li>
- <li class="toc-entry toc-h3"><a href="#methods">Methods</a>
- <ul>
- <li class="toc-entry toc-h4"><a href="#tab">$().tab</a></li>
- <li class="toc-entry toc-h4"><a href="#tabshow">.tab(‘show’)</a></li>
- <li class="toc-entry toc-h4"><a href="#tabdispose">.tab(‘dispose’)</a></li>
- </ul>
- </li>
- <li class="toc-entry toc-h3"><a href="#events">Events</a></li>
- </ul>
- </li>
- </ul>
- </nav>
+<!-- <nav class="d-none d-xl-block col-xl-2 bd-toc" aria-label="Secondary navigation">-->
+<!-- <ul class="section-nav">-->
+<!-- <li class="toc-entry toc-h2"><a href="#base-nav">Base nav</a></li>-->
+<!-- <li class="toc-entry toc-h2"><a href="#available-styles">Available styles</a>-->
+<!-- <ul>-->
+<!-- <li class="toc-entry toc-h3"><a href="#horizontal-alignment">Horizontal alignment</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#vertical">Vertical</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#tabs">Tabs</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#pills">Pills</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#fill-and-justify">Fill and justify</a></li>-->
+<!-- </ul>-->
+<!-- </li>-->
+<!-- <li class="toc-entry toc-h2"><a href="#working-with-flex-utilities">Working with flex utilities</a></li>-->
+<!-- <li class="toc-entry toc-h2"><a href="#regarding-accessibility">Regarding accessibility</a></li>-->
+<!-- <li class="toc-entry toc-h2"><a href="#using-dropdowns">Using dropdowns</a>-->
+<!-- <ul>-->
+<!-- <li class="toc-entry toc-h3"><a href="#tabs-with-dropdowns">Tabs with dropdowns</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#pills-with-dropdowns">Pills with dropdowns</a></li>-->
+<!-- </ul>-->
+<!-- </li>-->
+<!-- <li class="toc-entry toc-h2"><a href="#javascript-behavior">JavaScript behavior</a>-->
+<!-- <ul>-->
+<!-- <li class="toc-entry toc-h3"><a href="#using-data-attributes">Using data attributes</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#via-javascript">Via JavaScript</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#fade-effect">Fade effect</a></li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#methods">Methods</a>-->
+<!-- <ul>-->
+<!-- <li class="toc-entry toc-h4"><a href="#tab">$().tab</a></li>-->
+<!-- <li class="toc-entry toc-h4"><a href="#tabshow">.tab(‘show’)</a></li>-->
+<!-- <li class="toc-entry toc-h4"><a href="#tabdispose">.tab(‘dispose’)</a></li>-->
+<!-- </ul>-->
+<!-- </li>-->
+<!-- <li class="toc-entry toc-h3"><a href="#events">Events</a></li>-->
+<!-- </ul>-->
+<!-- </li>-->
+<!-- </ul>-->
+<!-- </nav>-->
<main class="col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content" role="main">
{{content}}
- <div class="row">
+ <div class="row btn-area-page" >
<div class="col-md-6">
- <a class="page-button"
+ {% if page.previous.url %}
+ <a href="{{page.previous.url}}" class="d-flex align-items-center page-btn shadow">
+ <div class="mr-auto">
+ <i class="fas fa-arrow-left fa-4x"></i>
+ </div>
+ <div class="text-right" >
+ <strong>Previous Page</strong>
+ <p class="title-page-btn">
+ {{page.previous.title | capitalize}}
+ </p>
+ </div>
+ </a>
+ {% endif %}
</div>
<div class="col-md-6">
-
+ {% if page.next.url %}
+ <a href="{{page.next.url}}" class="d-flex align-items-center page-btn shadow" >
+ <div class="text-left" >
+ <strong>Next Page</strong>
+ <p class="title-page-btn">
+ {{page.next.title | capitalize}}
+ </p>
+ </div>
+ <div class="ml-auto">
+ <i class="fas fa-arrow-right fa-4x"></i>
+ </div>
+ </a>
+ {% endif %}
</div>
</div>
+ {%- include footer.html -%}
</main>
</div>
</div>
-
-<!--{%- include header.html -%}-->
-
-<!--<div class="container-fluid p-0">-->
-<!-- {{content}}-->
-<!--</div>-->
-
-<!--{%- include footer.html -%}-->
-
{%- include scripts.html -%}
-
-<script>
- $(document).ready(function (){
- $('.nav-link').click(function() {
- $(this).toggleClass('active')
- });
- });
-</script>
</body>
</html>
diff --git a/wayang-docs/src/main/resources/assets/css/main.css b/wayang-docs/src/main/resources/assets/css/main.css
index 704b426..1f57dce 100644
--- a/wayang-docs/src/main/resources/assets/css/main.css
+++ b/wayang-docs/src/main/resources/assets/css/main.css
@@ -1,5 +1,4 @@
----
-license: |
+/**
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.
@@ -14,7 +13,7 @@
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.
----
+*/
.nav-link{
color: #3B454E !important;
@@ -37,13 +36,30 @@
width: calc(100% + 1px);
}
-.nav-link.disabled {
+.nav-link.main-link{
color: #ff8724 !important;
font-weight: bold;
text-transform: uppercase;
border-bottom: 1px solid #a00e5a;
}
+.nav-link.main-link > a{
+ color: #ff8724 !important;
+ font-weight: bold;
+ text-transform: uppercase;
+}
+
+.nav-link.main-link > a:hover{
+ color: #ff8724 !important;
+ font-weight: bold;
+ text-transform: uppercase;
+ text-decoration: none;
+}
+
+.nav-link.main-link.active {
+ color: #a00e5a !important;
+}
+
h1, h2, h3, h4 {
color: #ff8724 !important;
@@ -52,7 +68,67 @@
h1 {
border-bottom: 2px solid #a00e5a;
padding-top: 0.5em;
- padding-bottom: 1em;
+ padding-bottom: 0.1em;
font-weight: bold;
}
+.green{
+ background-color: green;
+}
+
+.red{
+ background-color: red;
+}
+
+.page-btn {
+ width: 100%;
+ height: 100px;
+ border: #a00e5a solid 1px;
+ padding: 1em;
+ color: #a00e5a;
+ text-decoration: none;
+ transition: border 0.3s linear;
+}
+
+.page-btn:focus, .page-btn:hover{
+ color: #a00e5a;
+ text-decoration: none;
+ border: #a00e5a solid 5px;
+}
+
+.title-page-btn{
+ color: #ff8724 !important;
+ font-size: 2em;
+ margin: 0;
+ margin-top: -0.3em;
+ padding: 0;
+ font-weight: 900;
+}
+
+.btn-area-page{
+ margin-top: 3em;
+ padding-top: 2em;
+ border-top: #a00e5a solid 2px;
+ margin-bottom: 2em;
+}
+
+.sub-menu{
+ margin-left: 1em;
+ border-left: 1px solid #a00e5a;
+}
+
+.link-btn {
+ width: 10%;
+ background-color: transparent;
+ vertical-align: middle !important;
+}
+
+.sub-menu:before {
+ content:'';
+ position: relative;
+ top: 0.25em;
+ left: -0.5em;
+ border-top: solid 0.5em #a00e5a;
+ border-left: solid 0.5em transparent;
+ border-right: solid 0.5em transparent;
+}
diff --git a/wayang-docs/src/main/resources/assets/js/menu.js b/wayang-docs/src/main/resources/assets/js/menu.js
new file mode 100644
index 0000000..90595e5
--- /dev/null
+++ b/wayang-docs/src/main/resources/assets/js/menu.js
@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+$(document).ready(function (){
+ var active_menu = $('#main-menu .active');
+ // open the parents element
+ active_menu.parents('div').collapse('show');
+ if(active_menu.hasClass('d-flex')){
+ active_menu.children('a').last().click();
+ }
+});
diff --git a/wayang-docs/src/main/resources/how_build/build_step.md b/wayang-docs/src/main/resources/how_build/build_step.md
new file mode 100644
index 0000000..e773d5c
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_build/build_step.md
@@ -0,0 +1,30 @@
+---
+license: |
+ 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.
+layout: default
+title: "Step by Step Building Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+menus:
+ build:
+ weight: 1
+---
+
+Step by Step Building Wayang
diff --git a/wayang-docs/src/main/resources/how_build/index.md b/wayang-docs/src/main/resources/how_build/index.md
new file mode 100644
index 0000000..48e1194
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_build/index.md
@@ -0,0 +1,27 @@
+---
+license: |
+ 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.
+layout: default
+title: "How to Build Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+---
+
+How to Build Wayang
diff --git a/wayang-docs/src/main/resources/how_contribute/bugs_report.md b/wayang-docs/src/main/resources/how_contribute/bugs_report.md
new file mode 100644
index 0000000..32117ff
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/bugs_report.md
@@ -0,0 +1,50 @@
+---
+license: |
+ 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.
+layout: default
+title: "Bugs Report"
+previous:
+ url: /how_contribute/
+ title: How to Contribute
+next:
+ url: /how_contribute/jira_issue_maintenance/
+ title: Jira Issue Maintenance
+menus:
+ contribute:
+ weight: 1
+---
+
+# Bug Reports
+
+## How to make a good Bug Report?
+
+Ideally, bug reports are accompanied by a proposed code change to fix the bug. This isn’t always possible, as those who **discover a bug may not have the experience to fix it, however, it needs to be reported** by creating a [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues).
+
+Before to contiues reading take a look on how to [Create Issues](https://support.atlassian.com/jira-software-cloud/docs/create-an-issue-and-a-sub-task/)
+
+Have in mind that a bug reports are only useful when they include enough information to understand, isolate and ideally reproduce the bug. Simply encountering an error does not mean a bug should be reported; as below, search in [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues). Unreproducible bugs, or simple error reports, may be closed if is not possible to collect enough information.
+
+It’s very helpful if the bug report has a description about how the bug was found it, the version of Wayang where occurs and the platform that was be setted at that moment, so that reviewers can easily understand the bug. It also helps committers to narrow down the problem to the root cause, because **it can be bug of the underline platform,** but is important figure out.
+
+**Performance regression** is also one kind of bug. The pull request to fix a performance regression must provide a benchmark to prove the problem is indeed fixed.
+
+Note that, **data correctness/data loss bugs are very serious**. Make sure of labeling the bug as `correctness` or `data-loss`, when you create the [Jira Issue](https://issues.apache.org/jira/projects/WAYANG/issues). If the bug report doesn’t get enough attention, please send an email to `dev@wayang.apache.org`, to draw more attentions.
+
+It is possible to propose new features as well. These are generally not helpful unless accompanied by detail, such as a design document and/or code change. Large new contributions should consider to be part of `wayang-core` but first needs to be discussed on the [Slack Channel](https://the-asf.slack.com/archives/C01H1CPE8KU). Feature requests may be rejected, or closed after a long period of inactivity.
+
+### Label meaning
+
+TODO: add the label meaning
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/choosing_what_contribute.md b/wayang-docs/src/main/resources/how_contribute/code_changes/choosing_what_contribute.md
new file mode 100644
index 0000000..29254aa
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/choosing_what_contribute.md
@@ -0,0 +1,49 @@
+---
+license: |
+ 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.
+layout: default
+title: "Choosing What to Contribute"
+previous:
+ url: /how_contribute/code_changes/
+ title: Code Changes
+next:
+ url: /how_contribute/code_changes/code_review_criteria/
+ title: Code Review Criteria
+menus:
+ code_changes:
+ weight: 1
+---
+
+# Choosing What to Contribute
+
+Wayang is a great project but currently we are searching for having more hand on the code. Review can take hours or days of committer time. Everyone benefits if contributors focus on changes that are useful, clear, easy to evaluate, and already pass basic checks.
+
+Sometimes, a contributor will already have a particular new change or bug in mind. If seeking ideas, consult the list of starter tasks in [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues), or ask the [email list@dev](mailto:dev@wayang.apache.org).
+
+Before proceeding, contributors should evaluate if the proposed change is likely to be relevant, new and actionable:
+
+* Is it clear that code must change? Proposing a [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) and pull request is appropriate only when a clear problem or change has been identified. If simply having trouble using Wayang, use the [email list@dev](mailto:dev@wayang.apache.org) first, rather than consider filing a [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) or proposing a change.
+
+* Search on dev@wayang.apache.org for related discussions. Often, the problem has been discussed before, with a resolution that doesn’t require a code change, or recording what kinds of changes will not be accepted as a resolution.
+* Search [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) for existing issues.
+
+* Type `[search terms]` at the search box. If a logically similar issue already exists, then contribute to the discussion on the existing[Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) and pull request first, instead of creating a new one.
+* Is the scope of the change matched to the contributor’s level of experience? Anyone is qualified to suggest a typo fix, but refactoring core scheduling logic requires much more understanding of Wayang. Some changes require building up experience first.
+
+<div class="alert alert-info" role="alert">
+It’s worth reemphasizing that changes to the core of Wayang, or to highly complex and important modules, are more difficult to make correctly. They will be subjected to more scrutiny, and held to a higher standard of review than changes to less critical code. As result of this, is important to be pacient in the coordination with Wayang Community to be sure that everything can works well after the change.
+</div>
+
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/code_review_criteria.md b/wayang-docs/src/main/resources/how_contribute/code_changes/code_review_criteria.md
new file mode 100644
index 0000000..2798eaa
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/code_review_criteria.md
@@ -0,0 +1,54 @@
+---
+license: |
+ 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.
+layout: default
+title: "Code Review Criteria"
+previous:
+ url: /how_contribute/code_changes/choosing_what_contribute/
+ title: Choosing What to Contribute
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/
+ title: Preparing to Contribute Code Changes
+menus:
+ code_changes:
+ weight: 2
+---
+# Code Review Criteria
+
+Before considering how to contribute code, it’s useful to understand how code is reviewed, and why changes may be rejected. See the [detailed guide for code reviewers](https://google.github.io/eng-practices/review/) from Google’s Engineering Practices documentation. Simply put, changes that have many or large positives, and few negative effects or risks, are much more likely to be merged, and merged quickly. Risky and less valuable changes are very unlikely to be merged, and may be rejected outright rather than receive iterations of review.
+
+**Positives**
+
+* Fixes the root cause of a bug in existing functionality
+* Adds functionality or fixes a problem needed by a large number of users
+* Simple, targeted
+* Maintains or improves consistency across Python, Java, Scala
+* Easily tested; has tests
+* Reduces complexity and lines of code
+* Change has already been discussed and is known to committers
+* Contribute in the test coverage of the code
+
+**Negatives, Risks**
+
+* Band-aids a symptom of a bug only
+* Introduces complex new functionality, especially an API that needs to be supported
+* Adds complexity that only helps a niche use case, may be can generate a library then be part of the core.
+* Changes a public API or semantics \(rarely allowed\)
+* Adds large dependencies
+* Changes versions of existing dependencies, if is not mandatory or for security reasons.
+* Adds a large amount of code
+* Makes lots of modifications in one “big bang” change, but can be considere in a new version.
+
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/index.md b/wayang-docs/src/main/resources/how_contribute/code_changes/index.md
new file mode 100644
index 0000000..984122f
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/index.md
@@ -0,0 +1,29 @@
+---
+license: |
+ 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.
+layout: default
+title: "Code Changes"
+previous:
+ url: /how_contribute/documentation_changes/
+ title: Documentation Changes
+next:
+ url: /how_contribute/code_changes/choosing_what_contribute/
+ title: Choosing What to Contribute
+---
+
+# Code Changes
+
+Apache Wayang is an open source system, and we try to everyone can contribute on it, so feel free to contribute but please read our process to make your life easy 😉. If you have any doubt please write on our [email list@dev](mailto:dev@wayang.apache.org).
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/closing_pull_request.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/closing_pull_request.md
new file mode 100644
index 0000000..7ff4d57
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/closing_pull_request.md
@@ -0,0 +1,32 @@
+---
+license: |
+ 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.
+layout: default
+title: "Closing Your Pull Request and Github Issues"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/pull_request/
+ title: Pull Request
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/review_process/
+ title: The Review Process
+menus:
+ preparing_code_changes:
+ weight: 3
+---
+
+# Closing Your Pull Request and Github Issues
+
+TODO: add this
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/code_style_guide.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/code_style_guide.md
new file mode 100644
index 0000000..9951965
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/code_style_guide.md
@@ -0,0 +1,31 @@
+---
+license: |
+ 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.
+layout: default
+title: "Code Style Guide"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/review_process/
+ title: The Review Process
+next:
+ url: /how_contribute/reviewing_changes/
+ title: Reviewing Changes
+menus:
+ preparing_code_changes:
+ weight: 5
+---
+
+# Code Style Guide
+TODO: add this
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/index.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/index.md
new file mode 100644
index 0000000..e415877
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/index.md
@@ -0,0 +1,45 @@
+---
+license: |
+ 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.
+layout: default
+title: "Preparing to Contribute Code Changes"
+previous:
+ url: /how_contribute/code_changes/code_review_criteria/
+ title: Code Review Criteria
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/jira_issue/
+ title: Jira issues
+---
+# Preparing to Contribute Code Changes
+
+Please review the preceding section before proposing a code change. This section documents how to do so.
+
+<div class="alert alert-success" role="alert">
+<h2> Important </h2>
+<hr>
+<strong>When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project’s open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project’s open source license and warrant that you have the legal authority to do so.</strong>
+</div>
+
+### Cloning the Wayang Source Code
+
+If you are interested in working with the newest under-development code or contributing to Wayang development, you can check out the master branch from Git:
+
+```text
+# Master development branch
+git clone https://github.com/apache/incubator-wayang
+```
+
+Once you’ve downloaded Wayang, you can find instructions for [installing]({% link how_install/index.md %}) and [building]({% link how_build/index.md %}) it on the [Wayang documentation](https://wayang.apache.org/docs/latest/).
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/jira_issue.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/jira_issue.md
new file mode 100644
index 0000000..c9f3ae1
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/jira_issue.md
@@ -0,0 +1,62 @@
+---
+license: |
+ 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.
+layout: default
+title: "Jira issues"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/
+ title: Preparing to Contribute Code Changes
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/pull_request/
+ title: Pull Request
+menus:
+ preparing_code_changes:
+ weight: 1
+---
+
+# Jira issues
+
+Currently, Wayang uses [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) to track logical issues, including bugs and improvements, and uses GitHub pull requests to manage the review and merge of specific code changes. That is, [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) are used to describe _what_ should be fixed or changed, and high-level approaches, and pull requests describe _how_ to implement that change in the project’s source code. For example, major design decisions are discussed in [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues).
+
+1. Find the existing [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) that the change pertains to.
+ 1. Do not create a new [Jira Issue](https://issues.apache.org/jira/projects/WAYANG/issues) if creating a change to address an existing issue in [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues); add to the existing discussion and work instead
+ 2. Look for existing pull requests that are linked from the [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues), to understand if someone is already working on the [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues).
+2. If the change is new, then it usually needs a new [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues). However, trivial changes, where the what should change is virtually the same as the how it should change do not require a [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues). Example: `Fix typos in Foo scaladoc`
+3. If required, create a new [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues):
+ 1. Provide a descriptive Title. “Update web UI” or “Problem in scheduler” is not sufficient. “Kafka Streaming support fails to handle empty queue in YARN cluster mode” is good.
+ 2. Write a detailed Description. For bug reports, this should ideally include a short reproduction of the problem. For new features, it may include a design document.
+ 3. Set required fields:
+ 1. **Issue Type**. Generally, Bug, Improvement and New Feature are the only types used in Wayang, look more [here]({% link how_contribute/jira_issue_maintenance.md %}).
+ 2. **Priority**. Set to Major or below; higher priorities are generally reserved for committers to set. The main exception is correctness or data-loss issues, which can be flagged as Blockers. Their meaning is roughly:
+ 1. Blocker: pointless to release without this change as the release would be unusable to a large minority of users. Correctness and data loss issues should be considered Blockers for their target versions.
+ 2. Critical: a large minority of users are missing important functionality without this, and/or a workaround is difficult.
+ 3. Major: a small minority of users are missing important functionality without this, and there is a workaround
+ 4. Minor: a niche use case is missing some support, but it does not affect usage or is easily worked around
+ 5. Trivial: a nice-to-have change but unlikely to be any problem in practice otherwise
+ 3. **Component**
+ 4. **Affects Version**. For Bugs, assign at least one version that is known to exhibit the problem or need the change
+ 5. **Label**. Not widely used, except for the following:
+ * `correctness`: a correctness issue
+ * `data-loss`: a data loss issue
+ * `release-notes`: the change’s effects need mention in release notes. The [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) or pull request should include detail suitable for inclusion in release notes – see “Docs Text” below.
+ * `starter`: small, simple change suitable for new contributors
+ 6. **Docs Text**: For issues that require an entry in the release notes, this should contain the information that the release manager should include in Release Notes. This should include a short summary of what behavior is impacted, and detail on what behavior changed. It can be provisionally filled out when the [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues) is opened, but will likely need to be updated with final details when the issue is resolved.
+ 4. Do not set the following fields:
+ 1. **Fix Version**. This is assigned by committers only when resolved.
+ 2. **Target Version**. This is assigned by committers to indicate a PR has been accepted for possible fix by the target version.
+ 5. Do not include a patch file; pull requests are used to propose the actual change.
+4. If the change is a large change, consider inviting discussion on the issue at [email list\#dev](mailto:dev@wayang.apache.org) first before proceeding to implement the change.
+
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
new file mode 100644
index 0000000..37f4b5d
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/pull_request.md
@@ -0,0 +1,32 @@
+---
+license: |
+ 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.
+layout: default
+title: "Pull Request"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/jira_issue/
+ title: Jira issues
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/closing_pull_request/
+ title: Closing Your Pull Request and Github Issues
+menus:
+ preparing_code_changes:
+ weight: 2
+---
+
+# Pull Request
+
+TODO: add this
diff --git a/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/review_process.md b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/review_process.md
new file mode 100644
index 0000000..f941293
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/code_changes/preparing_contribute_code_changes/review_process.md
@@ -0,0 +1,33 @@
+---
+license: |
+ 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.
+layout: default
+title: "The Review Process"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/closing_pull_request/
+ title: Closing Your Pull Request and Github Issues
+next:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/code_style_guide/
+ title: Code Style Guide
+menus:
+ preparing_code_changes:
+ weight: 4
+---
+
+# The Review Process
+
+TODO: add this
+
diff --git a/wayang-docs/src/main/resources/how_contribute/documentation_changes.md b/wayang-docs/src/main/resources/how_contribute/documentation_changes.md
new file mode 100644
index 0000000..0656758
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/documentation_changes.md
@@ -0,0 +1,35 @@
+---
+license: |
+ 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.
+layout: default
+title: "Documentation Changes"
+previous:
+ url: /how_contribute/jira_issue_maintenance/
+ title: Jira Issue Maintenance
+next:
+ url: /how_contribute/code_changes/
+ title: Code Changes
+menus: contribute
+menus:
+ contribute:
+ weight: 3
+---
+
+# Documentation Changes
+
+To propose a change to _release_ documentation \(that is, docs that appear on [Wayang documentation](https://wayang.apache.org/docs)\), edit the Markdown source files in the repository [incubator-wayang/wayang-docs](https://github.com/apache/incubator-wayang/tree/main/wayang-docs), the documentation is write usign jekyll, because of this reason maybe you will found some weird code in the markdown files. The process to propose a doc change is otherwise the same as the process for proposing [code changes](code-changes/preparing_contribute_code_changes/).
+
+If you want to make bigger contribution, please send a email to `dev@wayang.apache.org`, to give you more information how to do it.
diff --git a/wayang-docs/src/main/resources/how_contribute/helping_users.md b/wayang-docs/src/main/resources/how_contribute/helping_users.md
new file mode 100644
index 0000000..b7adfb8
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/helping_users.md
@@ -0,0 +1,38 @@
+---
+license: |
+ 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.
+layout: default
+title: "Helping Other Users"
+previous:
+ url: /how_contribute/user_libraries_wayang/
+ title: User Libraries to Wayang
+next:
+ url: /how_contribute/slack_channels/
+ title: Slack Channels
+menus:
+ contribute:
+ weight: 9
+---
+
+# 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.
+
+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.
+
+See the Guide for guidelines about how to effectively participate in discussions on the mailing list, as well as forums like StackOverflow.
+
+
diff --git a/wayang-docs/src/main/resources/how_contribute/index.md b/wayang-docs/src/main/resources/how_contribute/index.md
new file mode 100644
index 0000000..b4c227b
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/index.md
@@ -0,0 +1,24 @@
+---
+license: |
+ 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.
+layout: default
+title: "How to Contribute"
+next:
+ url: /how_contribute/bugs_report/
+ title: Bugs Report
+---
+
+How to Contribute
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
new file mode 100644
index 0000000..fda271f
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/jira_issue_maintenance.md
@@ -0,0 +1,56 @@
+---
+license: |
+ 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.
+layout: default
+title: "Jira Issue Maintenance"
+previous:
+ url: /how_contribute/bugs_report/
+ title: Bugs Report
+next:
+ url: /how_contribute/documentation_changes/
+ title: Documentation Changes
+menus:
+ contribute:
+ weight: 2
+---
+# Jira Issue Maintenance
+
+Given the sheer volume of issues raised in the [Jira Issues](https://issues.apache.org/jira/projects/WAYANG/issues), inevitably some issues are duplicates, or become obsolete and eventually fixed otherwise, or can’t be reproduced, or could benefit from more detail, and so on. It’s useful to help identify these issues and resolve them, either by advancing the discussion or even resolving the [Issues](https://issues.apache.org/jira/projects/WAYANG/issues). Most contributors are able to directly resolve [Issues](https://issues.apache.org/jira/projects/WAYANG/issues). Use judgment in determining whether you are quite confident the issue should be resolved, although changes can be easily undone. If in doubt, just leave a comment on the [Issues](https://issues.apache.org/jira/projects/WAYANG/issues).
+
+When resolving [Issue](https://issues.apache.org/jira/projects/WAYANG/issues), observe a few useful conventions:
+
+* Resolve as **Fixed** if there’s a change you can point to that resolved the issue
+ * Set Fix Version\(s\), if and only if the resolution is Fixed
+ * Set Assignee to the person who most contributed to the resolution, which is usually the person who opened the PR that resolved the issue.
+ * In case several people contributed, prefer to assign to the more ‘junior’, non-committer contributor
+* For issues that can’t be reproduced against master as reported, resolve as **Cannot Reproduce**
+ * Fixed is reasonable too, if it’s clear what other previous pull request resolved it. Link to it.
+* If the issue is the same as or a subset of another issue, resolved as **Duplicate**
+ * Make sure to link to the [Issue](https://issues.apache.org/jira/projects/WAYANG/issues) it duplicates
+ * Prefer to resolve the issue that has less activity or discussion as the duplicate
+* If the issue seems clearly obsolete and applies to issues or components that have changed radically since it was opened, resolve as **Not a Problem**
+* If the issue doesn’t make sense – not actionable, for example, a non-Wayang issue, resolve as **Invalid,** but if produce by an underline platform please link the report on the underline platform
+* If it’s a coherent issue, but there is a clear indication that there is not support or interest in acting on it, then resolve as **Won’t Fix,** and explain the "why" we will not fix it**.**
+* Umbrellas are frequently marked **Done** if they are just container issues that don’t correspond to an actionable change of their own
+
+## Types of Label of the Issues
+
+TODO: complete this part
+* Bug:
+* Feature Request:
+* Suggestion:
+
+
diff --git a/wayang-docs/src/main/resources/how_contribute/reviewing_changes.md b/wayang-docs/src/main/resources/how_contribute/reviewing_changes.md
new file mode 100644
index 0000000..9b2e07a
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/reviewing_changes.md
@@ -0,0 +1,34 @@
+---
+license: |
+ 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.
+layout: default
+title: "Reviewing Changes"
+previous:
+ url: /how_contribute/code_changes/preparing_contribute_code_changes/code_style_guide/
+ title: Code Style Guide
+next:
+ url: /how_contribute/testing_releases/
+ title: Testing Releases
+menus:
+ contribute:
+ weight: 6
+---
+
+# Reviewing Changes
+
+Changes to Wayang source code are proposed, reviewed and committed via [GitHub pull request](https://github.com/apache/incubator-wayang/pulls) \([described here 🔗 ](/how_contribute/code_changes/preparing_contribute_code_changes/pull_request/)\). Anyone can view and comment on active changes here. Reviewing others’ changes is a good way to learn how the change process works and gain exposure to activity in various parts of the code. You can help by reviewing the changes and asking questions or pointing out issues – as simple as typos or small issues of style.
+
+
diff --git a/wayang-docs/src/main/resources/how_contribute/slack_channels.md b/wayang-docs/src/main/resources/how_contribute/slack_channels.md
new file mode 100644
index 0000000..8af8fb8
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/slack_channels.md
@@ -0,0 +1,31 @@
+---
+license: |
+ 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.
+layout: default
+title: "Slack Channels"
+previous:
+ url: /how_contribute/helping_users/
+ title: Helping Other Users
+menus:
+ contribute:
+ weight: 10
+---
+
+# Slack Channels
+
+TODO: analyse if is necessary to do it
+
+
diff --git a/wayang-docs/src/main/resources/how_contribute/testing_releases.md b/wayang-docs/src/main/resources/how_contribute/testing_releases.md
new file mode 100644
index 0000000..70c86ed
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/testing_releases.md
@@ -0,0 +1,33 @@
+---
+license: |
+ 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.
+layout: default
+title: "Testing Releases"
+previous:
+ url: /how_contribute/reviewing_changes/
+ title: Reviewing Changes
+next:
+ url: /how_contribute/user_libraries_wayang/
+ title: User Libraries to Wayang
+menus:
+ contribute:
+ weight: 7
+---
+
+# Testing Releases
+
+Wayang’s release process is community-oriented, and members of the community can vote on new releases on the [email list@dev](mailto:dev@wayang.apache.org). Wayang users are invited to subscribe to the email list \#Dev to receive announcements, and test their workloads on newer release and provide feedback on any performance or correctness issues found in the newer release.
+
diff --git a/wayang-docs/src/main/resources/how_contribute/user_libraries_wayang.md b/wayang-docs/src/main/resources/how_contribute/user_libraries_wayang.md
new file mode 100644
index 0000000..0ec64a3
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_contribute/user_libraries_wayang.md
@@ -0,0 +1,32 @@
+---
+license: |
+ 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.
+layout: default
+title: "User Libraries to Wayang"
+previous:
+ url: /how_contribute/testing_releases/
+ title: Testing Releases
+next:
+ url: /how_contribute/helping_users/
+ title: Helping Other Users
+menus:
+ contribute:
+ weight: 8
+---
+
+# User Libraries to Wayang
+
+TODO: add this
diff --git a/wayang-docs/src/main/resources/how_install/index.md b/wayang-docs/src/main/resources/how_install/index.md
new file mode 100644
index 0000000..20cb008
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_install/index.md
@@ -0,0 +1,27 @@
+---
+license: |
+ 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.
+layout: default
+title: "How to Install Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+---
+
+How to Install Wayang
diff --git a/wayang-docs/src/main/resources/how_install/install_step.md b/wayang-docs/src/main/resources/how_install/install_step.md
new file mode 100644
index 0000000..329a3ef
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_install/install_step.md
@@ -0,0 +1,30 @@
+---
+license: |
+ 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.
+layout: default
+title: "Step by Step Building Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+menus:
+ install:
+ weight: 1
+---
+
+Step by Step Install Wayang
diff --git a/wayang-docs/src/main/resources/how_run/index.md b/wayang-docs/src/main/resources/how_run/index.md
new file mode 100644
index 0000000..3e9cd01
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_run/index.md
@@ -0,0 +1,27 @@
+---
+license: |
+ 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.
+layout: default
+title: "How to Run Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+---
+
+How to Run Wayang
diff --git a/wayang-docs/src/main/resources/how_run/run_step.md b/wayang-docs/src/main/resources/how_run/run_step.md
new file mode 100644
index 0000000..81048c4
--- /dev/null
+++ b/wayang-docs/src/main/resources/how_run/run_step.md
@@ -0,0 +1,30 @@
+---
+license: |
+ 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.
+layout: default
+title: "Step by Step Run Wayang"
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+menus:
+ run:
+ weight: 1
+---
+
+Step by Step run Wayang
diff --git a/wayang-docs/src/main/resources/index.md b/wayang-docs/src/main/resources/index.md
index 1761a24..0d50a4e 100644
--- a/wayang-docs/src/main/resources/index.md
+++ b/wayang-docs/src/main/resources/index.md
@@ -15,10 +15,20 @@
See the License for the specific language governing permissions and
limitations under the License.
layout: default
-title: "Home"
+title: "Read Me"
+menus: header
+previous:
+ url: /
+ title: previous
+next:
+ url: /
+ title: next
+menus:
+ header:
+ weight: 0
---
-# Apache Wayang <img align="right" width="170px" src="https://wayang.apache.org/assets/img/logo/logo_400x160.png" alt="Wayang logo">
+# Apache Wayang <img align="right" style="margin-top: -0.5em;" width="170px" src="https://wayang.apache.org/assets/img/logo/logo_400x160.png" alt="Wayang logo">
[](https://travis-ci.org/wayang-ecosystem/wayang)
[](https://gitter.im/wayang-ecosystem/Lobby)
