Documentation¶

Truco

Documentation on this site is written in ReStructuredText, or RST for short. Please check the RST Primer if you are not familiar with RST.

Esta páxina guiarate ao escribir unha gran documentación para o proxecto UBports que se pode presentar neste sitio.

Directrices da documentación¶

These rules govern how you should write documentation to avoid problems with style, format or linking.

Título¶

Todas as páxinas deben ter un título de documento que se mostrará no índice (barra lateral esquerda) e na parte superior da páxina.

Os títulos deben estar «con maiúsculas de frases» en lugar de «con maiúsculas con frases». Por exemplo:

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

Non hai unha única definición de título de maiúsculas que todo o mundo siga, pero a de frase é doada. Isto axuda a manter a maiúscula na táboa de contido consistente.

Page titles are underlined with equals signs. For example, the markup for Información de erros includes the following title:

Bug reporting
=============

Teña en conta que:

O título iníciase con maiúscula
O título sublíñase con signos de igual
O subliñado abrangue o título completamente sen sobresaír

Algúns exemplos incorrectos de títulos:

Maiúsculas incorrectas
Bug Reporting =============
Subliñado demasiado curto
Bug reporting =====
Subliñado demasiado longo
Bug reporting ================

Cabeceiras¶

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.

Táboa de contidos¶

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.

Movendo páxinas¶

Ás veces faise necesario mover unha páxina dun lugar da documentación a outro. Xeralmente trátase de mellorar o fluxo de documentos: por exemplo, ten máis sentido que a páxina veña despois dunha páxina que acaba de engadir nunha sección diferente.

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).

A continuación móstranse algúns exemplos de situacións nas que debería crear redireccións.

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"

Avisos¶

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.

Lonxitude de liña¶

Non hai ningunha restrición na lonxitude da liña neste repositorio. Por favor, non rompa as liñas cunha lonxitude arbitraria. En lugar diso, activa a configuración de palabras no editor de texto.

Fluxo de traballo das contribucións¶

The following steps explain how you can make a contribution to this documentation.

Nota

You will need a GitLab account to complete these steps. If you do not have an account, go to gitlab.com to create one.

Bifurcación do repositorio¶

You can make more advanced edits to the documentation by forking ubports/docs.ubports.com on GitLab.

Compilación da documentación¶

To build this documentation, follow these instructions on your local copy of your fork of the repository.

The documentation can be built by running ./build.sh in the root of this repository. The script will also create a virtual build environment in ~/ubportsdocsenv if none is present.

If all went well, you can enter the _build/html directory and open index.html to view the UBports documentation.

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.

Comprobación final da túa contribución¶

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étodos alternativos para contribuír¶

Traducións¶

Pode atopar os compoñentes deste documento para traducir en its project in UBports Weblate.

Escritura de documentos en formatos diferentes ao RST¶

Se desexa escribir documentos para UBports pero non é cómodo escribir ReStructuredText, escriba sen formato e publíqueo no Foro UBports na sección correspondente (probablemente Xeral). Alguén poderá axudarche a revisar o borrador e escribir o texto reestruturado necesario.

Incomodidade con 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.

POR FACER actuais¶

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

Tarefa pendente

Consider also writing a document about process of dealing with merge requests.

(O entrada orixinal está situado en /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-gl/checkouts/latest/about/process/issue-tracking.rst, liña 36.)

Tarefa pendente

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.

(O entrada orixinal está situado en /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-gl/checkouts/latest/appdev/webapp/index.rst, liña 19.)

Tarefa pendente

Document the process for Nexus 4 (mako)

(O entrada orixinal está situado en /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-gl/checkouts/latest/systemdev/kernel-hal.rst, liña 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.