Documentation¶

Suggerimento

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

Questa pagina ti guiderà attraverso la corposa documentazione del progetto UBports che può essere descritto su questo sito.

Linee guida per la documentazione¶

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

Titolo¶

Tutte le pagine devono aver un titolo di documento, che sarà mostrato nell’indice (a sinistra) in cima alla pagina.

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

Non c’è una sola definizione di formattazione titolo che tutti seguano, ma la formattazione della affermazioni è facile. Questo rende la formattazione dell’indice consistente.

I titoli delle pagine sono sottolineati con i segni di uguale. Per esempio, il markup di Segnalazione dei bug include il seguente titolo:

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

Si noti che:

Il titolo è incassato a frase
Il titolo è sottolineato con i segni di uguale
La sottolineatura attraversa completamente il titolo senza oltrepassarlo

Esempi di titoli non corretti sono:

Involucro errato
Bug Reporting =============
Sottolineare troppo breve
Bug reporting =====
Sottolineare troppo
Bug reporting ================

Denominazioni¶

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.

Indice¶

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.

Pagine mobili¶

A volte diventa necessario spostare una pagina da un posto nella documentazione ad un altro. Generalmente questo è per migliorare il flusso dei documenti: Ad esempio, ha più senso per la pagina venire dopo una pagina che hai appena aggiunto in una sezione diversa.

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

Ciò che segue sono alcuni esempi di situazioni in cui si dovrebbe creare redirect.

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"

Avvertimenti¶

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.

Lunghezza della linea¶

In questo repository non ci sono restrizioni sulla lunghezza delle righe. Si prega di non interrompere le righe a una lunghezza arbitraria. Attivare invece il word wrap nel proprio editor di testo.

Flusso del contributo¶

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.

Duplicando i repository¶

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

Creazione della documentazione¶

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

La documentazione può essere creata eseguendo ./build.sh nella radice di questo repository. Lo script creerà anche un ambiente virtuale di creazione ~/ubportsdocsenv, qualora non fosse presente.

Se tutto andasse bene, potrai accedere alla cartella _build e aprire index.html per vedere la documentazione di 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.

Verifica finale del contributo¶

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

Metodi alternativi per contribuire¶

Translations¶

Puoi trovare i componenti di questo documento da tradurre in its project in UBports Weblate.

Scrivere documenti non nel formato RST¶

In caso ti interessasse scrivere documenti per UBports ma non sei a tuo agio nel compilare un TestoRistrutturato, ti preghiamo di scriverlo e postarlo su UBports Forum nella relativa sezione (verosimilmente General). Qualcuno ti aiuterà a revisionare la tua bozza e a scrivere il TestoRistrutturato richiesto.

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

Attuali 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

Da fare

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

(L'riga originale si trova in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-it/checkouts/latest/about/process/issue-tracking.rst, linea 36.)

Da fare

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'riga originale si trova in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-it/checkouts/latest/appdev/webapp/index.rst, linea 19.)

Da fare

Documentare il processo per Nexus 4 (mako)

(L'riga originale si trova in /home/docs/checkouts/readthedocs.org/user_builds/docsubportscom-gitlab-it/checkouts/latest/systemdev/kernel-hal.rst, linea 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.