Tutorial sull’uso di GGeditor

il tutorial è molto semplice nei passi da seguire, partendo innanzitutto da questo video:


Come installare GGeditor

Clicca questo link per il plug-in da installare su Google Docs, oppure in un documento Google:

  1. Sul menu «componenti aggiuntivi» clicca “Installa componenti aggiuntivi”
  2. Nel box di ricerca edita GGeditor, e clicca sull’icona di GGeditor per installare.

L’editor GG parte da uno scenario composto da 2 situazioni:

  1. Tu già hai un repository di progetto su Github,
  2. Tu già hai un progetto su Readthedocs.org che è in diretta relazione al repository su Github.

Github e Readthedocs accettano formati RST o Markup. Hai bisogno di costruire la documentazione in uno di questi due formati.


Il flusso di lavoro del processo che gestisce GGeditor

Questo è il flusso di lavoro con GGeditor per costruire la documentazione su Github:

IMG1


Le azioni svolte da GGeditor

La sequenza di azioni che vengono effettuate da GGeditor su Google Doc nel processo che esso stesso gestisce. Ecco le fasi:

  1. iniziare creando un nuovo documento su Google Docs.

  2. Il nuovo file sarà nominato «Tutorial» (come nel caso di questa pagina che state leggendo). Il file contiene un’intestazione, un’immagine e una nota creata dal sidebar di GGeditor.

  3. Il nuovo file sarà compilato da GGeditor sul repository del progetto Github.

  4. Siccome questo è un file nuovo, un processo sarà avviato per costruire il legame agli altri documenti (es. index) nel repository Github. Il processo avviato include:

    1. log-in all’account Github che ospita il progetto su Github,
    2. azioni di navigazione dentro Github,
    3. creazione di un nuovo file
    4. e l’attività di compilazione (commit di Github).

Importante

  1. Quando nomini il tuo documento Google Doc, il nome del documento non necessita del suffisso .rst.
  2. Per legare il file del Google Doc sul repository del progetto (Github), Github ha bisogno del suffisso .rst. Il suffisso sarà automaticamente creato da GGeditor. Se nomini manualmente tu il file su Github allora aggiungi il suffisso .rst (sulla directory docs di Github).

Suggerimento

Il contenuto di questa pagina che stai leggendo è in questo Google Doc