workgroup:documentation:start
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
workgroup:documentation:start [2017/03/20 03:24] Hamish Willee |
workgroup:documentation:start [2017/05/17 23:22] Hamish Willee |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Documentation WG ====== | ====== Documentation WG ====== | ||
| + | |||
| + | ===== ARCHIVED ===== | ||
| + | |||
| + | This working group has made the necessary decisions/discussions required for docs work in the coming year. As the remit of the WG is met it has now been closed/archived. | ||
| + | |||
| + | Achievements include: | ||
| + | - Launched the refreshed DC site | ||
| + | - Agreed proposal for creating a unified DC branding strategy across the sites (a common footer and some common branding elements like fonts etc.) | ||
| + | - Created template and regular process for WG updates | ||
| + | - Moved all docs to infrastructure (Gitbook) with common plugins | ||
| + | - Enabled translation of documentation and have started to engage with the community. | ||
| + | |||
| + | The documentation work will of course continue. If you want to be involved contact us on [[http://discuss.dronecode.org/c/site-feedback|dronecode discuss]] or email: hamishwillee AT gmail DOT com. | ||
| ===== Overview ===== | ===== Overview ===== | ||
| Line 5: | Line 18: | ||
| The Documentation WG is tasked to improve the Dronecode and project sites and to extend and maintain developer and user documentation. | The Documentation WG is tasked to improve the Dronecode and project sites and to extend and maintain developer and user documentation. | ||
| - | The group are currently looking at how to: | + | The group remit currently includes looking at how to: |
| * Create a compelling and unified Dronecode platform story across project websites. | * Create a compelling and unified Dronecode platform story across project websites. | ||
| * Document and update the Dronecode Roadmap and release cycle. | * Document and update the Dronecode Roadmap and release cycle. | ||
| Line 18: | Line 31: | ||
| * **Lead:** Hamish Willee | * **Lead:** Hamish Willee | ||
| * **Members:** Peter Adams (Intel), Beatriz Palmeiro (Intel), Ulisses Furquim (Intel), Luis Strano (Intel), Chris Anderson (DroneCode), Mark Charlebois (Qualcomm), Hamish Willee (DroneCode, Dronekit), Lorenz Meier (PX4, QGC), Beat Küng (PX4) | * **Members:** Peter Adams (Intel), Beatriz Palmeiro (Intel), Ulisses Furquim (Intel), Luis Strano (Intel), Chris Anderson (DroneCode), Mark Charlebois (Qualcomm), Hamish Willee (DroneCode, Dronekit), Lorenz Meier (PX4, QGC), Beat Küng (PX4) | ||
| - | * **Meetings:** Weekly on Weds 11am PST / 6.15 am AEST | + | * **Meetings:** See below. |
| * **Contact:** [[http://discuss.dronecode.org/c/site-feedback|Site feedback]] or email: hamishwillee at gmail dot com | * **Contact:** [[http://discuss.dronecode.org/c/site-feedback|Site feedback]] or email: hamishwillee at gmail dot com | ||
| + | |||
| + | ===== Meetings ===== | ||
| + | |||
| + | Meetings are *nominally* held weekly for 45 minutes at the following time: | ||
| + | |||
| + | * Melbourne, Australia (AEST): Thursday 6.15 am | ||
| + | * Geneva, Switzerland: Weds 10.15pm | ||
| + | * San Francisco, USA: Weds 1.15pm | ||
| + | |||
| + | If you're interested in attending, then please email us to confirm that meeting is being held and get details (hamishwillee at gmail dot com). | ||
| ===== Current status ===== | ===== Current status ===== | ||
| - | * Updated Dronecode site is being prototyped. | + | * Dronecode site is being refreshed. |
| * The site will continue to hold information about membership but will additionally become a hub for information about working with the platform/projects, and for getting hold of source code, roadmap information and documentation. | * The site will continue to hold information about membership but will additionally become a hub for information about working with the platform/projects, and for getting hold of source code, roadmap information and documentation. | ||
| - | * Site will be migrating from Drupal to WordPress in coming months, and we will have much greater control over content. | + | * Site will be migrating from Drupal to WordPress in April/May timeframes. |
| + | * We will have much greater control over content. | ||
| * Working Group wiki pages. | * Working Group wiki pages. | ||
| * These have been created/updated for most WGs. | * These have been created/updated for most WGs. | ||
| Line 33: | Line 57: | ||
| * A template has been created and a number of updates have been posted. | * A template has been created and a number of updates have been posted. | ||
| * We hope to get all WG Leads posting in the coming months. | * We hope to get all WG Leads posting in the coming months. | ||
| - | * The PX4 User Guide is being migrated to Gitbook | ||
| - | * All main Dronecode projects will share the same documentation toolchain. | ||
| - | * Translation is much better supported by Gitbook than WordPress. | ||
| * Create a compelling and unified Dronecode platform story | * Create a compelling and unified Dronecode platform story | ||
| * We have started to look at options to roll out across project sites, including common fonts/headers, footers, some common menus and branding elements. | * We have started to look at options to roll out across project sites, including common fonts/headers, footers, some common menus and branding elements. | ||
| + | * Documentation improvements: | ||
| + | * The PX4 User Guide has been [[https://docs.px4.io/en/|migrated to Gitbook]] | ||
| + | * All main Dronecode projects now share the same documentation toolchain. | ||
| + | * All the QGroundControl and PX4 docs sites have been made ready for translation | ||
| + | * We've started to engage Korean and Chinese translator communities. | ||
| + | * Useful Gitbook plugins have been added to all sites, including plugins for per-page TOC. | ||
| ===== Open issues ===== | ===== Open issues ===== | ||
| - | We are working through open issues. None are reported here, because nothing is "blocking", just not discussed yet. | + | Currently unable to document release notes as there is no TSC-approved set. |
workgroup/documentation/start.txt · Last modified: 2017/05/17 23:25 by Hamish Willee
Page Tools
