Documentation¶
Astuce
La documentation sur ce site est écrite en ReStructuredText, ou RST en version courte. Veuillez consulter l”introduction à RST si vous n’êtes pas familier avec celui-ci.
Cette page vous guidera dans l’écriture d’une bonne documentation pour le projet UBports pouvant être mise en avant sur ce site.
Recommandations pour l’écriture de la documentation¶
These rules govern how you should write documentation to avoid problems with style, format or linking.
Titre¶
Toutes les pages doivent avoir un titre de document qui sera affiché dans le sommaire (volet de gauche) et en haut de la page.
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
Il n’existe pas de règle unique que tout le monde puisse suivre pour l’écriture des titres, mais mettre des minuscules est simple. Cela aide à conserver les majuscules de manière cohérente dans le sommaire.
Les titres des pages sont soulignés avec des signes égal. Par exemple, le balisage pour Remonter un problème comprend le titre suivant :
Bug reporting
=============
Notez que :
La casse du titre est celle d’une phrase
Le titre est souligné avec des signes égal
Le soulignement couvre complètement le titre sans le dépasser
Voici quelques exemples incorrects de titres :
Casse incorrecte
Bug Reporting =============
Soulignement trop court
Bug reporting =====
Soulignement trop long
Bug reporting ================
Rubriques¶
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.
Sommaire¶
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.
Déplacement des pages¶
Il est parfois nécessaire de déplacer une page d’un endroit à l’autre de la documentation. En général, cela permet d’améliorer la fluidité de la documentation. Par exemple, il est plus logique que la page vienne après une page que vous venez d’ajouter dans une autre section.
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).
Voici quelques exemples de situations dans lesquelles vous devez créer des redirections.
You are moving systemdev/calendars.rst to appdev/calendars.rst. Add the following to the redirects.txt file:
"systemdev/calendars.txt" "appdev/calendars.txt"
You are moving appdev/clickable.rst into several pages in appdev/clickable/ to give significantly more information about the tool than there was previously. You have created an introduction page, appdev/clickable/introduction.rst. In this case, it would be a good idea to redirect the old page to the new introduction page. This can be done by adding the following to redirects.txt:
"appdev/clickable.rst" "appdev/clickable/introduction.rst"
Avertissements¶
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.
Longueur de ligne¶
Il n’y a pas de restriction de longueur de ligne dans ce dépôt. Veuillez ne pas faire de renvoi à la ligne pour une longueur arbitraire de longueur de ligne. À la place, activez le retour à la ligne automatique dans votre éditeur de texte.
Circuit de contribution¶
The following steps explain how you can make a contribution to this documentation.
Note
You will need a GitLab account to complete these steps. If you do not have an account, go to gitlab.com to create one.
Clonage du répertoire¶
You can make more advanced edits to the documentation by forking ubports/docs.ubports.com on GitLab.
Compilation de la documentation¶
To build this documentation, follow these instructions on your local copy of your fork of the repository.
La documentation peut être compilée en exécutant ./build.sh à la racine de ce répertoire. Le script créera également un environnement virtuel de compilation dans ~/ubportsdocsenv s’il n’est pas déjà présent.
Si tout s’est bien passé, vous pourrez accéder au répertoire _build et ouvrir index.html pour visualiser la documentation d’UBports.
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.
Contrôle final de votre contribution¶
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
Méthodes alternatives pour contribuer¶
Traductions¶
Le contenu de ce document est disponible à la traduction au niveau de son projet sous le Weblate d’UBports.
Rédaction de documents dans un format autre que RST¶
Si vous souhaitez écrire des documents pour UBports mais que vous n’êtes pas à l’aise avec l’écriture en ReStructuredText, veuillez l’écrire sans formatage et l’afficher sur le Forum UBports dans la section appropriée (probablement Général). Quelqu’un pourra vous aider à réviser votre ébauche et à rédiger le texte restructuré requis.
Mal à l’aise avec 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.
Actuellement à faire¶
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
À faire
Pensez également à rédiger un document sur le processus de traitement des demandes de fusion.
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-fr/checkouts/latest/about/process/issue-tracking.rst, à la ligne 36)
À faire
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.
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-fr/checkouts/latest/appdev/webapp/index.rst, à la ligne 19)
À faire
Document the process for Nexus 4 (mako)
(l'entrée originale se trouve dans /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-fr/checkouts/latest/systemdev/kernel-hal.rst, à la ligne 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.