Confirmed users
656
edits
Community:SummerOfCode19:Brainstorming: Difference between revisions
Community:SummerOfCode19:Brainstorming (view source)
Revision as of 16:25, 5 February 2019
, 5 February 2019→2019 Proposed Project List
Klahnakoski (talk | contribs) (add tuid project) |
|||
| Line 251: | Line 251: | ||
| JSX/React some Python | | JSX/React some Python | ||
| [https://mozillians.org/en-US/u/ekyle/ Kyle Lahnakoski] | | [https://mozillians.org/en-US/u/ekyle/ Kyle Lahnakoski] | ||
| [https://mozillians.org/en-US/u/ | | [https://mozillians.org/en-US/u/ekyle/ Kyle Lahnakoski] | ||
| [https://github.com/mozilla/active-data-recipes/pull/112/files#diff-0f126940e57c54541662345b499622f1 PR with proposal] or [https://github.com/mozilla/active-data-recipes/tree/master/docs/Student%20Project%20190130.md Read more] | | [https://github.com/mozilla/active-data-recipes/pull/112/files#diff-0f126940e57c54541662345b499622f1 PR with proposal] or [https://github.com/mozilla/active-data-recipes/tree/master/docs/Student%20Project%20190130.md Read more] | ||
| Line 262: | Line 262: | ||
| [https://github.com/mozilla/TUID/blob/dev/docs/Student%20Project%20190204.md Read more] | | [https://github.com/mozilla/TUID/blob/dev/docs/Student%20Project%20190204.md Read more] | ||
|- | |||
| Firefox Source Docs Infrastructure | |||
| Improve the infrastructure underpinning Firefox's [https://firefox-source-docs.mozilla.org/ in-tree documentation]. | |||
| Python, Sphinx, Rst | |||
| [https://mozillians.org/en-US/u/ahal/ Andrew Halberstadt] | |||
| TBD | |||
| Writing docs for Firefox's in-tree [https://firefox-source-docs.mozilla.org/ source docs] is time consuming and difficult and the end result is difficult to navigate. | |||
With [https://developer.mozilla.org/en-US/ MDN] de-prioritizing build and workflow docs, we need a suitable replacement for all of Firefox's contribution and workflow documentation. The great advantage of documentation living in-tree, is that it can be updated along with the source. Unfortunately the current system to build and generate docs is difficult to write for, slow to build and generates poorly organized documentation. These factors discourage developers from creating or updating docs. | |||
This project aims to improve the documentation experience via static analysis tools (e.g hint when docs might need to be updated), enabling linters, faster build times, additional language support and well structured hierarchies. Help make documentation a bigger part of our developer's day to day workflow. | |||
|- | |- | ||
| ..your next idea here! | | ..your next idea here! | ||