| .. 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. |
| |
| Introduction |
| ============ |
| |
| What are we doing? |
| ------------------ |
| |
| This document is being provided to help everyday amateur to advanced programmers contribute to the Apache Wave |
| documentation. If you would like to learn more about apache wave itself please visit |
| https://incubator.apache.org/wave/ . |
| |
| This document provides information in setting up and contributing to the documentation process using the Sphinx |
| project and ReStructured Text. This is also provided as an example for the other documents in the Git repository |
| . |
| |
| Who is doing this? |
| ------------------ |
| |
| The Apache Wave project is being developed in the Apache Foundations Incubator and comprises of volunteers. |
| |
| |
| Why are we doing this? |
| ---------------------- |
| |
| The Apache Wave project has been in the incubator since 2010 and has had a lacking of documentation or |
| development progress due to its large complexity. By making the documentation process easier the project hopes |
| to remove the barriers for new developers to start contributing. |