Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-26 15:59:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

GSoD: few more projects

Browse Source
This commit is contained in:
Marek Marczykowski-Górecki 2019-04-23 12:38:23 +02:00
parent d501959b29
commit a1ed95a389
No known key found for this signature in database
GPG Key ID: F32894BE9684938A
1 changed files with 64 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
basics_dev/gsod.md
View File

@ -99,6 +99,67 @@ Here's a suggested template for adding project ideas:
**Mentor**: [Michael Carbone][team]
### Improve Disposable VMs documentation
**Project**: Improve Disposable VMs documentation
**Brief explanation**: Current Disposable VMs documentation is scarce, inconsistent in places and in scattered across multiple pages, sometimes hard to find.
This project is about consolidating it into one or few easy to find pages, covering all related subjects.
And written in way easy to follow and understand, clearly separating basic use cases, advanced ones and internal details.
Additionally, terminology is used inconsistently.
**Expected results**:
- Review existing Disposable VM documentation
- Propose new documentation layout, including split between pages
- Propose updated and clarified content
**Knowledge prerequisite**:
- basic Qubes OS knowledge - [intro], [getting started]
- [Markdown][markdown]
**Mentor**: [Marek Marczykowski-Górecki][team]
### Rewrite qrexec documentation
**Project**: Rewrite qrexec documentation
**Brief explanation**: Current qrexec (qubes remote exec) documentation is hard to follow, important informations are hidden within a wall of text.
Some parts are split into multiple sections, for example version specific to avoid duplication, but it doesn't help reading it.
Additionally, protocol documentation describes only few specific use cases, instead of being clear and precise protocol specification.
Fixing this last point may require very close cooperation with developers, as the current documentation doesn't multiple corner cases (that's one of the issue with its current shape).
**Expected results**:
- Review existing [qrexec documentation](https://www.qubes-os.org/doc/qrexec3/) and an [issue about it](https://github.com/QubesOS/qubes-issues/issues/1392)
- Propose updated, consolidated admin documentation (policy writing, adding services)
- Propose consolidated protocol specification, based on the current documentation, and cooperation with developers
**Knowledge prerequisite**:
- [Markdown][markdown]
**Mentor**: [Marek Marczykowski-Górecki][team]
### Consolidate troubleshooting guides
**Project**: Consolidate troubleshooting guides
**Brief explanation**: Troubleshooting guides are scattered across many pages and sometimes incomplete, leading to repeatedly posting the same instruction over and over when helping users to diagnose problems.
This could be helped by writing consolidated guide with with a clear list of symptom-action layout.
**Expected results**:
- Review existing [troubleshooting guides](https://www.qubes-os.org/doc/#troubleshooting)
- Review [issues][doc-issues] containing common troubleshooting steps (checking specific logs etc)
- Propose updated, consolidated troubleshooting documentation, including its layout
**Knowledge prerequisite**:
- [Markdown][markdown]
**Mentor**: [Marek Marczykowski-Górecki][team]
[gsod]: https://developers.google.com/season-of-docs/
[team]: /team/
@ -108,5 +169,8 @@ Here's a suggested template for adding project ideas:
[gsod-2019-thread]: https://groups.google.com/d/msgid/qubes-project/aac9b148-4081-ebd8-cb9d-9a9191033484%40qubes-os.org
[Documentation Guidelines]: /doc/doc-guidelines/
[Help, Support, and Mailing Lists]: /support/
[intro]: /intro/
[getting started]: /getting-started/
[markdown]: https://daringfireball.net/projects/markdown/
[doc-issues]: https://github.com/QubesOS/qubes-issues/issues?q=is%3Aopen+is%3Aissue+label%3A%22C%3A+doc%22