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/03 21:05] – add Refresh and refactor web interface documentation idea aparcar1 | google-season-of-docs [2020/06/08 14:58] – added batman and maint/upgrade ops for remote routers steve-newcomb | ||
|---|---|---|---|
| Line 5: | Line 5: | ||
| **The link is added within the application and so this site shouldn' | **The link is added within the application and so this site shouldn' | ||
| - | ===== Project Ideas ===== | + | ====== Project Ideas ====== |
| - | **Project | + | ===== Project |
| - | **Description: | + | The OpenWrt system is based on several core components, all developed in different code repositories. Each component has documentation that is mainly targeted at OpenWrt developers, but can also be used by " |
| - | OpenWrt is based on multiple sub projects, all developed in different | + | The goal of the project |
| - | repositories. | + | |
| - | the OpenWrt main website. Keeping both in sync is not trivial due to very | + | |
| - | tooling. This project idea propose the transfer and extension | + | |
| - | documentation to the sub-projects repositories. Having both code and | + | |
| - | documentation in the same repository has two big advantages over the current | + | |
| - | approach: | + | |
| - | | + | |
| + | - transfer all documentation | ||
| + | - 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 | ||
| - | * New developers find latest documentation next to the code, instead | + | It is not required |
| - | Code documentation | + | Having both code and documentation in the same repository |
| - | Markdown format and stored | + | |
| - | like `mkdocs` would be introduced to offer a webpage per project. The current | + | |
| - | wiki would list those documentation websites. | + | |
| - | **Related material:** | + | |
| + | | ||
| - | * The to be individually documented projects are found on https:// | ||
| - | * Some of the projects are already documented in the current wiki https:// | + | === Related material === |
| + | * [[commit>? | ||
| + | * [[: | ||
| + | * [[: | ||
| - | ---- | + | ===== Project |
| - | + | ||
| - | **Project | + | |
| - | + | ||
| - | **Description: | + | |
| Device pages, important for users, are often very similar but still vary in | Device pages, important for users, are often very similar but still vary in | ||
| Line 55: | Line 48: | ||
| to form a page prioritization list. | to form a page prioritization list. | ||
| - | **Related material:** | + | === Related material |
| * An existing proof of concept for device documentation exists https:// | * An existing proof of concept for device documentation exists https:// | ||
| - | ---- | ||
| - | **Project | + | ===== Project |
| - | + | ||
| - | **Description: | + | |
| The wiki offers guides on how to use the LuCI, the OpenWrt web interface, for | The wiki offers guides on how to use the LuCI, the OpenWrt web interface, for | ||
| Line 77: | Line 67: | ||
| documentation easily future proof and translatable. | documentation easily future proof and translatable. | ||
| - | **Related material:** | + | === Related material |
| * The existing LuCI documentation at https:// | * The existing LuCI documentation at https:// | ||
| + | |||
| + | |||
| + | ===== Project 4: Showcase OpenWrt features and use-cases ===== | ||
| + | |||
| + | OpenWrt has a very wide ecosystem of packages that allow many different use-cases going beyond the simple "home router" | ||
| + | |||
| + | The idea is to " | ||
| + | |||
| + | The expected benefits for OpenWrt users are: increased awareness of OpenWrt features, easier access to advanced setups. | ||
| + | |||
| + | Some examples of features and use-cases to showcase: | ||
| + | |||
| + | * detailed monitoring of LAN traffic with nlbwmon or vnstat | ||
| + | * setting up a mobile connection (4G) as backup | ||
| + | * DNS filtering, similar to Pi-hole | ||
| + | * decentralized Wi-Fi controller between several Wi-Fi access points with Dawn | ||
| + | * local file-sharing setup (USB disk shared with Samba/ | ||
| + | * VPN client/ | ||
| + | * VPN server: connect remote clients to your LAN network | ||
| + | * improving performance of low-end Internet connections by using SQM to avoid bufferbloat | ||
| + | * simple multi-WAN setup with mwan3 | ||
| + | * advanced multi-WAN setup using MPTCP/ | ||
| + | * run applications in LXC containers | ||
| + | * community mesh network using B.A.T.M.A.N. | ||
| + | * maintenance/ | ||
| + | |||
| + | === Related material === | ||
| + | |||
| + | * [[docs: | ||
| + | * [[docs: | ||
| + | * [[https:// | ||
| + | * [[https:// | ||
| + | * [[docs: | ||
| + | * [[docs: | ||
| + | * [[https:// | ||
| + | |||
| + | ===== Project 5: Improve first-time user experience ===== | ||
| + | |||
| + | OpenWrt can be challenging for new users: is my hardware supported? which version of OpenWrt should I use? can i use snapshots? how do I install OpenWrt? what are all these strange " | ||
| + | |||
| + | The idea of the project is to identify the main hurdles encountered by first-time users, and solve these hurdles to improve the first-time user experience: | ||
| + | |||
| + | * if the necessary resources already exist (e.g. Table of Hardware, quick start page), make them more visible or improve them | ||
| + | * if the necessary resources don't exist, create them | ||
| + | |||
| + | The proposed solution could include a " | ||
| + | |||
| + | === Related material === | ||
| + | |||
| + | * [[supported_devices|Supported devices / Table of Hardware]] | ||
| + | * [[downloads|Download page]] | ||
| + | * [[docs: | ||
| + | * [[docs: | ||
| + | * See also Project 2 (for installation) and Project 3 (for basic web interface usage) | ||