<!---
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.
--->
# NOTES:

## menus
the menus is using the plugin jekyll-menus, the documentation is [here](https://github.com/forestryio/jekyll-menus)



Structure of documentation

[comment]: <> (TODO: add the internal structure of every topics)
What is Wayang?
    Concepts
    Overview
getting start Wayang
    Building wayang
    installing wayang
    using wayang
    how to develop on wayang
Using Wayang
    Api Java/Scala
        overview
        configurations
        examples
    API Python
        overview
        configurations
        examples
    .... same for API-SQL and futures api
    calibrating the model
Extending Wayang
    Adding a platform
        Creating the plugin
        creating an operator
        creating the mapping (1 to 1, 1 to n)
        creating channel
        creating the compiler
        wrapping udf and others
How to Contribute
    Bugs Report
    Jira Issue Maintenance
    Documentation changes
    Code change
        Choosing what to contribute
        code review criteria
        preparing to contribute code changes
            jira issues
            pull request
            closing your pull request and jira issue
    review process
    code style guide
    reviewing changes
    testing releases
    user libraries to wayang
    helping other users
