Documentation Office Hours - Editing Discourse and Sphinx-Based Documentation
Offered By: Ubuntu OnAir via YouTube
Course Description
Overview
Join a live Documentation Office Hours session covering recent planning discussions, forum updates, and live demonstrations of editing Discourse-based documentation and Sphinx-Starter-Pack documentation. Learn about Madrid updates, Office Hours scheduling, and ideas for future sessions. Watch live demos of recent posts, explore Discourse-based documentation editing, and discover the Discedit tool. Dive into the Documentation starter pack using Sphinx, understand Makefiles, and see how to use 'make run' for live previews. Learn to add new documents to the index, test documentation, track changes on Discourse, and manage contributors. This 39-minute session, hosted by the Technical Authors team at Canonical, offers valuable insights for anyone interested in improving their documentation skills.
Syllabus
Introduction
Madrid updates
Office Hours index
Office Hours schedule
Office Hours ideas
Live demo of recent posts
Discourse-based documentation
Editing a Discourse post
Discedit https://github.com/niemeyer/discedit
Documentation starter pack Sphinx
Makefiles
make run
Live preview of documentation
Adding new documents to the index
Testing Documentation
Tracking changes on Discourse
Managing contributors on Discourse
Taught by
Ubuntu OnAir
Related Courses
The Data Scientist’s ToolboxJohns Hopkins University via Coursera How to Use Git and GitHub
Udacity Ruby on Rails: An Introduction
Johns Hopkins University via Coursera Accediendo a la nube con iOS
Tecnológico de Monterrey via Coursera Responsive Website Development and Design Capstone
University of London International Programmes via Coursera