-
Notifications
You must be signed in to change notification settings - Fork 692
Call for Volunteers: Documentation updates #2989
Copy link
Copy link
Closed
Labels
docsBad or missing help texts / documentationBad or missing help texts / documentationhelp wantedThis issue needs additional developer support, or specialized skills to help debug or troubleshoot.This issue needs additional developer support, or specialized skills to help debug or troubleshoot.staleThis issue has not had any activity in 60 days :(This issue has not had any activity in 60 days :(🔥 hotAn issue which affects multiple users, and needs to be fixed immediatelyAn issue which affects multiple users, and needs to be fixed immediately
Metadata
Metadata
Assignees
Labels
docsBad or missing help texts / documentationBad or missing help texts / documentationhelp wantedThis issue needs additional developer support, or specialized skills to help debug or troubleshoot.This issue needs additional developer support, or specialized skills to help debug or troubleshoot.staleThis issue has not had any activity in 60 days :(This issue has not had any activity in 60 days :(🔥 hotAn issue which affects multiple users, and needs to be fixed immediatelyAn issue which affects multiple users, and needs to be fixed immediately
For the next release of OpenShot (whichever and whenever that should be), one of the still-unaddressed needs is documentation.
The manual was mostly written in 2017, with only very minor updates since then. (The last new documentation written was the EDL / XML import and export docs, added on 2019-05-25 by @jonoomph in commit b1422e1.)
Documentation needs (working list)
Volunteers welcome!
Any volunteers who'd be interested in helping to improve the manual, both directly (writing documentation) and indirectly (soliciting, organizing, and copyediting contributions from developers) would be greatly appreciated.
Writing and editing OpenShot documentation
The source files for the manual are all found in the project repository (the
doc/directory), the preferred method for submitting edits would be via GitHub Pull Request but we can make accommodations for anyone who'd like to contribute but isn't familiar with version-control systems like Git.Generating a local copy of the manual requires only the Python-based Sphinx documentation system and the Sphinx RTD theme, which can be installed via
pip3 install sphinx sphinx-rtd-themeor using most package managers. I can provide support to anyone who'd like to contribute and needs help with installing and using Sphinx.