User Manuals: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== | == Overview == | ||
''At this point in time, there are no comprehensive User Guides for OpenPetra users available.'' | ''At this point in time, there are no comprehensive User Guides for OpenPetra users available.'' | ||
===Current Options=== | ===Current Options=== | ||
* A [[Basic Tutorial]] on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra. | * A [[Basic Tutorial]] on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra. | ||
* | * A first start has been made at https://docs.openpetra.org/ and https://handbuch.openpetra.de/ | ||
==Goals of OpenPetra User Guides== | |||
===Content=== | |||
* Should provide thorough instructions and answers on how to use OpenPetra effectively. | |||
===Portable=== | |||
* User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format. | |||
===Authoring of User Guides=== | ===Authoring of User Guides=== | ||
==== | ====Using Sphinx==== | ||
The plan is to write the content of the User Guides | The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files. | ||
See https://docs.openpetra.org/contributions/index.html for more details! | |||
Sphinx projects can be published at https://readthedocs.org/ | |||
Latest revision as of 06:29, 10 September 2022
Overview
At this point in time, there are no comprehensive User Guides for OpenPetra users available.
Current Options
- A Basic Tutorial on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra.
- A first start has been made at https://docs.openpetra.org/ and https://handbuch.openpetra.de/
Goals of OpenPetra User Guides
Content
- Should provide thorough instructions and answers on how to use OpenPetra effectively.
Portable
- User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format.
Authoring of User Guides
Using Sphinx
The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.
See https://docs.openpetra.org/contributions/index.html for more details!
Sphinx projects can be published at https://readthedocs.org/