4.7 KiB
| layout | title | permalink |
|---|---|---|
| sidebar | Google Season of Docs | /gsod/ |
Google Season of Docs
Thank you for your interest in participating in the Google Season of Docs program with the Qubes OS team. You can read more about the Google Season of Docs in the official guides and FAQ.
Project Ideas List
Everyone is encouraged to add ideas to this list, either by editing this page directly (preferred) or by replying to this thread (then we'll add it to this page for you). (See our Documentation Guidelines for general information about how to submit changes to the documentation, and see Help, Support, and Mailing Lists for information about our mailing lists.)
We currently have over a hundred open documentation issues in our issue tracker. Please feel free to use these for project ideas, as appropriate.
Here's a suggested template for adding project ideas:
### Adding a Proposal
**Project**: Something that you're totally excited about.
**Brief explanation**: What is the project?
**Expected results**: What is the expected result in the timeframe given?
**Knowledge prerequisite**: Pre-requisites for working on the project. What knowledge or resources are needed? If applicable, links to more information or discussions.
**Mentor**: Name and email address.
Offline documentation
Project: Offline documentation
Brief explanation: Qubes OS has thorough documentation on the project website, however a user may find it more convenient to view documentation - especially for troubleshooting network issues -- offline on their Qubes machine. This will improve usability for new users and better support users if they need to troubleshoot anything.
Expected results:
- Review past discussions on the issue
- Recommend workflow and platform for displaying offline documentation
- Test workflow and platform to ensure usability and functionality
Knowledge prerequisite:
- none
Mentor: Marek Marczykowski-Górecki
Create guide on firstboot for new users
Project: Create guide on firstboot for new users
Brief explanation: When a user first boots Qubes after installing it, there is an opportunity to introduce the user to some of the unique functionality Qubes has. This could be the same content as the improved getting started page.
Expected results:
- Review past discussions on the issue
- Provide visual mock-ups and proposed text
Knowledge prerequisite:
- some experience with Anaconda would be helpful
Mentor: Marek Marczykowski-Górecki
Improve Qubes Intro page
Project: Improve Qubes Intro page
Brief explanation: The Intro page is the first place a prospective user goes for information about Qubes OS. It is currently text-heavy and in Question & Answer format. This project is to re-write and design the Intro page to be more appealing to prospective users.
Expected results:
- Review the existing page and website, similar pages for other OSes
- Provide visual mock-ups and proposed text
Knowledge prerequisite:
- none
Mentor: Michael Carbone
Improve Getting Started page
Project: Improve Getting Started page
Brief explanation: The Getting Started page is the place a new user would go to understand better how to use Qubes. It is currently has old screenshots not using the default desktop environment and could have much better flow. In addition, this improved page content may end up being served more directly to the user via the offline documentation or the firstboot guide.
Expected results:
- Review the existing page and website, similar pages for other OSes
- Provide visual mock-ups and proposed text
Knowledge prerequisite:
- none
Mentor: Michael Carbone