What is Season of Docs?
Season of Docs is a new Google program focussed on helping to improve the quality of documentation in open source software. The Apache Software Foundation is applying to participate in this year's Season of docs and we have created this page to capture and record the list of documentation project ideas from all Apache projects.
How do I participate?
A notification will be sent out to all Apache projects about our application for Season of Docs. If your project would like to participate then you can add your documenatation ideas in the table below.
List of Project Ideas
Each project idea must include at least the following information:
- Project name: Choose a concise but descriptive title.
- Description: A longer description of the documentation work required. Describe your initial idea in detail. Offer opportunities for any interested technical writers to expand or refine the idea.
Related material:
- Link to the open source project that needs documentation.
- If you're proposing a technical writing project that involves updates to an existing documentation set, link to that documentation set.
- If you're proposing a tutorial or a set of how-to guides, describe the features or use cases that need documenting.
- If you're proposing a contributor's guide, link to any existing README file or other relevant material if present. If there's nothing available yet, it's fine to say that.
- Include links to similar documentation in other projects, if relevant.
| Id | Apache Project | Documentation Project Name | Description | Mentors | Links to Related Material |
|---|---|---|---|---|---|
| 1 | Apache Rya (incubating) | Query Optimization in Apache Rya | The purpose of this project is to document the way SPARQL query optimization works in Rya and create a how-to guide for users who want to use this feature | Adina Crainiceanu (adina@apache.org), Don Needham | https://rya.apache.org/documentation/ |
| 2 | Apache Dubbo (incubating) | Improve the doc for integrating Dubbo with service registry | Add documentation of how Dubbo work with registry center like etcd, consul, by following the zookeeper integration documentation | Huxing Zhang (huxing@apache.org), Jun Liu (liujun@apache.org) | - Doc: http://dubbo.apache.org/en-us/docs/user/quick-start.html - Blog: http://dubbo.apache.org/en-us/blog/dubbo-zk.html |
| 3 | Apache Dubbo (incubating) | Improve documentation for Dubbo load balancing | Add documentation of how to use various load balancing strategies, like Random, Consistent Hashing, etc. | Huxing Zhang (huxing@apache.org), Jun Liu (liujun@apache.org) | - Doc: http://dubbo.apache.org/en-us/docs/user/demos/loadbalance.html |
| 4 | |||||
| 5 | |||||
| 6 | |||||
| 7 | |||||
| 8 | |||||
| 9 | |||||