Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
| google-season-of-docs [2020/05/22 10:50] – Add project 5 zorun | google-season-of-docs [2020/06/08 14:58] – added batman and maint/upgrade ops for remote routers steve-newcomb | ||
|---|---|---|---|
| Line 7: | Line 7: | ||
| ====== Project Ideas ====== | ====== Project Ideas ====== | ||
| - | ===== Project 1: Sub-project specific documentation | + | ===== Project 1: Documentation for OpenWrt components |
| - | OpenWrt is based on multiple sub projects, all developed in different | + | The OpenWrt |
| - | repositories. The documentation | + | |
| - | the OpenWrt | + | |
| - | tooling. This project idea propose the transfer and extension of existing | + | |
| - | documentation to the sub-projects repositories. Having both code and | + | |
| - | documentation in the same repository has two big advantages over the current | + | |
| - | approach: | + | |
| - | * Existing developers can use the same workflow | + | The goal of the project is to improve |
| + | - choose a documentation system (mkdocs, sphinx...) that will be applied consistently to all components | ||
| + | - transfer all documentation related to each component directly into the code repository of the component | ||
| + | - setup a system that builds all components documentation and makes the result easily available in a single place | ||
| + | - reorganize / improve each component documentation to improve consistency and readability | ||
| + | |||
| + | It is not required to have a deep technical knowledge of the components. | ||
| + | |||
| + | Having both code and documentation in the same repository has two big advantages over the current approach: | ||
| + | |||
| + | * Existing developers can use the same workflow to update and review documentation as they use for code. | ||
| * New developers find latest documentation next to the code, instead of finding it on some external website. | * New developers find latest documentation next to the code, instead of finding it on some external website. | ||
| - | Code documentation from the wikis technical reference would be converted to | ||
| - | Markdown format and stored in the repository. A documentation render engine | ||
| - | like `mkdocs` would be introduced to offer a webpage per project. The current | ||
| - | wiki would list those documentation websites. | ||
| === Related material === | === Related material === | ||
| - | * The to be individually documented projects are found on https:// | + | * [[commit>? |
| - | + | * [[: | |
| - | * Some of the projects are already documented in the current wiki https:// | + | * [[:docs:techref:start|Technical reference pages]] on the wiki |
| ===== Project 2: Refresh documentation for device installations ===== | ===== Project 2: Refresh documentation for device installations ===== | ||
| Line 93: | Line 93: | ||
| * advanced multi-WAN setup using MPTCP/ | * advanced multi-WAN setup using MPTCP/ | ||
| * run applications in LXC containers | * run applications in LXC containers | ||
| + | * community mesh network using B.A.T.M.A.N. | ||
| + | * maintenance/ | ||
| === Related material === | === Related material === | ||
| Line 102: | Line 104: | ||
| * [[docs: | * [[docs: | ||
| * [[docs: | * [[docs: | ||
| + | * [[https:// | ||
| ===== Project 5: Improve first-time user experience ===== | ===== Project 5: Improve first-time user experience ===== | ||