Documentation¶
Tipp
Dokumentationen auf dieser Seite werden in ReStructuredText geschrieben, oder kurz RST. Bitte RST Primer konsultieren, falls einem RST nicht geläufig sein sollte.
Diese Seite leitet zum Schreiben guter Dokumentationen für das UBports-Projekt an, die auf dieser Seite zur Verfügung gestellt wird.
Dokumentationsrichtlinien¶
These rules govern how you should write documentation to avoid problems with style, format or linking.
Titel¶
Alle Seiten müssen einen Dokumententitel haben, der im Inhaltsverzeichnis (linke Seitenleiste) und oben auf der Seite angezeigt wird.
Titles should be „sentence cased“ rather than „Title Cased“. For example:
Incorrect casing:
Writing A Good Bug Report
Correct casing:
Writing a good bug report
Correct casing when proper nouns are involved:
Installing Ubuntu Touch on your phone
Die Großschreibung von Wörtern im Titel führt zu Regelunklarheiten. Wird nur der Satzanfang groß geschrieben, herrscht Klarheit. Damit bleibt die Großschreibung im Inhaltsverzeichnis konsistent.
Seitentitel werden mit Gleichzeichen unterstrichen. Z.B. wird Fehler melden wie folgt hervorgehoben:
Bug reporting
=============
Regeln:
Nur der erste Buchstabe des Satzes wird groß geschrieben
Der Titel wird mit Gleichzeichen unterstrichen
Die Unterstreichung ist vollständig und endet mit dem letzten Buchstaben
Fehlerhafte Beispiele von Titeln:
Falsche Groß-/Kleinschreibung
Bug Reporting =============
Unterstreichung ist zu kurz
Bug reporting =====
Unterstreichung ist zu lang
Bug reporting ================
Überschriften¶
There are several levels of headings that you may place on a page. These levels are shown here in order:
Page title
==========
Level one
---------
Level two
^^^^^^^^^
Level three
"""""""""""
Please refrain from using more than four levels. If you think you need more levels, it is a good sign that the document should be split up into multiple pages. Furthermore the web version of the documentation only shows four levels in it’s table of contents.
Inhaltsverzeichnis¶
If you add a new page you also have to add it to the table of contents. You can do this by adding the page to the index.rst file in the same directory where you created it. For example, if you create a file called „newpage.rst“, you would add the line marked with a chevron (>) in the nearest index:
.. toctree::
:maxdepth: 1
:name: example-toc
oldpage
anotheroldpage
> newpage
The order matters. If you would like your page to appear in a certain position in the table of contents, place it there. In the previous example, newpage would be added to the end of this table of contents.
Seiten verschieben¶
Manchmal wird es notwendig, eine Seite in der Dokumentation an eine andere Stelle zu verschieben. Im Allgemeinen dient dies der Verbesserung des Dokumentflusses: So ist es z. B. sinnvoller, die Seite hinter einer gerade bearbeiteten Seite eines anderen Abschnittes einzufügen.
However, people link to our documentation from many sources that we do not control. Blogs, websites, and other documentation sites can direct people here using links that they may never update. It is a terrible experience to follow a link from a different site and land on a 404 page, being forced to search manually in our documentation.
We use a tool called Rediraffe to avoid such a bad experience. Rediraffe creates redirect pages, which can send a user from an old, invalid link to a new, useful link. Please create a redirect link when changing a page’s name or moving a page within the documentation’s directory structure. Redirect links are created by placing the filename of the old document and the filename of the new document, relative to the documentation’s root, in the redirects.txt file.
We use Rediraffe’s checkdiff builder to ensure that pages are not deleted from the documentation without a redirect in place. This builder is run as part of the build.sh script in the repository and as part of our automated build once you submit a Merge Request (MR).
Es folgen einige Beispiele für Fälle, in denen Sie Weiterleitungen erstellen sollten.
Wenn Sie systemdev/calendars.rst nach appdev/calendars.rst verschieben, fügen Sie Folgendes der Datei redirects.txt hinzu:
"systemdev/calendars.txt" "appdev/calendars.txt"
Wenn Sie appdev/clickable.rst auf mehrere Seiten in appdev/clickable/ verschieben, um deutlich mehr Informationen über das Tool bereitzustellen als zuvor, und wenn Sie eine Einführungsseite appdev/clickable/introduction.rst erstellt haben, wäre es in diesem Fall eine gute Idee, die alte Seite auf die neue Einführungsseite weiterzuleiten. Dies kann erreicht werden, indem Folgendes zur Datei redirects.txt hinzugefügt wird:
"appdev/clickable.rst" "appdev/clickable/introduction.rst"
Warnungen¶
Your edits must not introduce any warnings into the documentation build. If any warnings occur, the build will fail and the merge request will be marked with a red ‚X‘. Please ensure that your RST is valid and correct before you create a merge request. This is done automatically (via sphinx-build crashing with your error) if you follow our build instructions below.
Zeilenlänge¶
Es gibt keine Begrenzung für die Zeilenlänge in diesem Repository. Bitte keinen Zeilenumbruch an einer beliebigen Stelle einfügen.
Arbeitsablauf¶
The following steps explain how you can make a contribution to this documentation.
Bemerkung
You will need a GitLab account to complete these steps. If you do not have an account, go to gitlab.com to create one.
Forken des Repository¶
You can make more advanced edits to the documentation by forking ubports/docs.ubports.com on GitLab.
Die Dokumentation erzeugen¶
To build this documentation, follow these instructions on your local copy of your fork of the repository.
Die Dokumentation kann durch Ausführen von ./build.sh im Wurzelverzeichnis des Repository erzeugt werden. Das Skript erzeugt ebenfalls eine virtuelle Build-Umgebung in ~/ubportsdocsenv, falls noch nicht vorhanden.
Wenn alles gut geht, kann das Verzeichnis _build betreten und index.html geöffnet werden, um die UBports-Dokumentation anzuzeigen.
If you have trouble building the docs, the first thing to try is deleting the build environment. Run rm -r ~/ubportsdocsenv and try the build again.
Endkontrolle Ihres Beitrags¶
After you have created your Merge Request on GitLab, the Continuous Integration (CI) system will make a test build of your contribution (a „pipeline“). Please double check whether this builds successfully and whether the result looks as you intended it to:
at the top of the „Overview“ tab of your MR on gitlab you will see the status of the pipeline
if it says „Checking pipeline status“ or „Pipeline running“ then please wait another minute.
if it says „Pipeline failed“ with a red X and, then something went wrong, please click on the link to find the details
if it says „Pipeline passed“ with green check mark, it means the MR could be built successfully and you can proceed to look at the results
now please click on link of that pipeline
click on „build“ job
this brings you to the end of the build log, where you’ll see a message: „Build succeeded, browse the artifact here“
click the link next to it to see the full version of the UBports documentation site with your changes
double check whether your changes look ok
Alternative Methoden zur Beteiligung¶
Übersetzungen aktualisieren¶
Die Komponenten dieses Dokuments findet man zur Übersetzung auf UBports Weblate.
Dokumente ohne RST-Format schreiben¶
Falls man Dokumente für UBports schreiben möchte, sich aber unwohl bei der Verwendung von ReStructuredText fühlt, erstellt man das Dokument ohne Formatierung und teilt es im UBports Forum in einem passenden Abschnitt (wahrscheinlich Allgemein). Es wird sich jemand finden, der den erforderlichen ReStructuredText daraus formt.
Unsicher mit Git¶
If you’ve written a complete document in ReStructuredText but aren’t comfortable using Git or GitLab, please post it on the UBports Forum in the relevant section (likely General). Someone will be able to help you revise your draft and submit it to this documentation.
Aktuelle TODOs¶
This section lists the TODOs that have been included in this documentation. If you know how to fix one, please send us a merge request to make it better!
To create a todo, add this markup to your page:
.. todo::
My todo text
Zu tun
Consider also writing a document about process of dealing with merge requests.
(Der ursprüngliche Eintrag steht in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-de/checkouts/latest/about/process/issue-tracking.rst, Zeile 36.)
Zu tun
There is also another way to create somewhat more featureful webapps, sometimes referred to as webapp+ or alternative container. This needst to be properly documented. It’s a simple qml app that can be easily configured. Creation is almost as simple as ‚classic‘ webapp, but result is more powerfull with the a nice navigation feature. A rather advanced example of this is the YouTube app from Mateo Salta which has quite some modifications on top of the template.
(Der ursprüngliche Eintrag steht in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-de/checkouts/latest/appdev/webapp/index.rst, Zeile 19.)
Zu tun
Document the process for Nexus 4 (mako)
(Der ursprüngliche Eintrag steht in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-de/checkouts/latest/systemdev/kernel-hal.rst, Zeile 57.)
ReadTheDocs hosting¶
The actual documents website is built and hosted for us by the Read The Docs project. Our RTD setup contains one main project for English and one additional project for each supported language added as translations to the main project. If you are a maintainer and want to add a language, first create a new project with manual import and set the language appropriately. Afterwards add this as a translation in the Admin page of the main project.