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/06/08 09:00] – [Project 1: Sub-project specific documentation] zorun | google-season-of-docs [2020/06/08 14:58] – added batman and maint/upgrade ops for remote routers steve-newcomb | ||
|---|---|---|---|
| Line 9: | Line 9: | ||
| ===== Project 1: Documentation for OpenWrt components ===== | ===== Project 1: Documentation for OpenWrt components ===== | ||
| - | The OpenWrt system is based on several core components, all developed in different code repositories. | + | The OpenWrt system is based on several core components, all developed in different code repositories. |
| - | The goal of the project is to improve documentation of OpenWrt components by making it more consistent: | + | The goal of the project is to improve documentation of OpenWrt components by making it more consistent |
| - choose a documentation system (mkdocs, sphinx...) that will be applied consistently to all components | - choose a documentation system (mkdocs, sphinx...) that will be applied consistently to all components | ||
| - | - setup a system that builds all components documentation and makes the result easily available | ||
| - transfer all documentation related to each component directly into the code repository of the component | - 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 | - reorganize / improve each component documentation to improve consistency and readability | ||
| - | It is not required to have a deep technical knowledge of the components, | + | It is not required to have a deep technical knowledge of the components. However, in the first part of the project, the applicant will need to get familiar with the overall picture |
| Having both code and documentation in the same repository has two big advantages over the current approach: | Having both code and documentation in the same repository has two big advantages over the current approach: | ||
| Line 28: | Line 28: | ||
| === 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 ===== | ||