Editing Google Season of Docs
From BRL-CAD
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
= About GSoD = | = About GSoD = | ||
− | BRL-CAD | + | BRL-CAD is excited to be applying to participate in the inaugural 2019 [https://developers.google.com/season-of-docs/ Google Season of Docs] (GSoD)! |
− | [[File:GSoD2019.png|frameless| | + | [[File:GSoD2019.png|frameless|120px|left]] |
<blockquote style="background-color: lightgrey; border: solid thin grey;">The goal of [https://developers.google.com/season-of-docs/ Google Season of Docs] is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open source project's documentation. For technical writers who are new to open source, the program provides an opportunity to gain experience in contributing to open source projects. For technical writers who're already working in open source, the program provides a potentially new way of working together. Season of Docs also gives open source projects an opportunity to engage more of the technical writing community.</blockquote> | <blockquote style="background-color: lightgrey; border: solid thin grey;">The goal of [https://developers.google.com/season-of-docs/ Google Season of Docs] is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open source project's documentation. For technical writers who are new to open source, the program provides an opportunity to gain experience in contributing to open source projects. For technical writers who're already working in open source, the program provides a potentially new way of working together. Season of Docs also gives open source projects an opportunity to engage more of the technical writing community.</blockquote> | ||
Line 12: | Line 12: | ||
= How You Can Help = | = How You Can Help = | ||
− | The project has received little attention from professional technical writers in the past 15 years. Despite a rich documentation and development history (see | + | The project has received little attention from professional technical writers in the past 15 years. Despite a rich documentation and development history ( see http://brlcad.org/BRL-CAD_Bibliography.pdf ), BRL-CAD's docs are lacking in several fundamental respects such as introductory materials for new users, basic organization, and presentation. |
We especially need help with: | We especially need help with: | ||
− | * presenting BRL-CAD's existing | + | * creating documentation that specifically caters to new users |
+ | * presenting BRL-CAD's existing documentation in a more organized manner | ||
* getting all existing documentation under version control so we can manage better | * getting all existing documentation under version control so we can manage better | ||
− | * setting up | + | * setting up round-trip editing of documentation so we can update and maintain faster |
+ | * converting our doc management from Docbook XML to [https://docusaurus.io Docusaurus] or [https://antora.org Antora] | ||
= [https://brlcad.org/w/index.php?title=Google_Season_of_Docs/Project_Ideas PROJECT IDEAS] = | = [https://brlcad.org/w/index.php?title=Google_Season_of_Docs/Project_Ideas PROJECT IDEAS] = | ||
− | + | If you are interested in working with BRL-CAD on a documentation project, whether under GSoD or not, please see our [https://brlcad.org/w/index.php?title=Google_Season_of_Docs/Project_Ideas project ideas page]. Another good starting point for technical writers is our "[http://brlcad.org/HACKING_BRL-CAD.pdf HACKING BRL-CAD]" (pdf, 35MB) book which includes a section on contributing to documentation. | |
− | |||
− | If you are interested in working with BRL-CAD on a documentation project, whether under GSoD or not, please see our [https://brlcad.org/w/index.php?title=Google_Season_of_Docs/Project_Ideas |