Come creare un semplice wiki interno usando Gitbook

GitBook è una piattaforma che ti consente di creare siti di documentazione o wiki aziendali. Puoi usarlo per documentare tutti i tipi di cose, dal codice alle API e come utilizzare un prodotto software.

GitBook utilizza un processo simile ai repository GitHub. La copia principale della documentazione funge da copia 'master'. È quindi possibile creare 'bozze', che sono simili a 'rami'.

Questo processo consente a molti utenti di lavorare su un unico sito di documentazione mentre gestiscono o prevengono i conflitti. Consente inoltre alle modifiche di diversi rami di passare attraverso un processo di revisione prima di unirle.

Come iniziare a utilizzare GitBook

Puoi scegliere tra diversi Prezzi GitBook piani. Il prezzo dipenderà dall'utilizzo di GitBook per progetti open source, uso personale o collaborazione in team privati. GitBook è gratuito se lo utilizzi per progetti open source.

GitBook supporta Markdown, un popolare linguaggio di markup con molti vantaggi per scrivere o documentare sul web.

GitBook si integra anche con GitHub, una piattaforma per l'hosting, l'archiviazione e la modifica del codice . Puoi collegare il tuo account GitBook direttamente al tuo account GitHub accedendo utilizzando le tue credenziali GitHub.

Iscriviti a GitBook. Se hai il tuo account GitHub, puoi fare clic su Iscriviti con GitHub .
Dopo aver effettuato l'accesso, GitBook ti reindirizzerà a una nuova wiki interna. Precompilerà anche la tua wiki con alcuni contenuti di esempio.

Una panoramica dell'interfaccia di GitBook

GitBook ha diverse funzioni che ti consentono di creare e apportare modifiche al tuo sito di documentazione.

Il pannello superiore consente di creare nuove bozze, visualizzare la cronologia delle modifiche o visualizzare qualsiasi altra discussione o allegato.
La barra laterale più a sinistra ti consente di creare più spazi. È possibile utilizzare spazi separati per progetti diversi in modo da poter separare e organizzare le aree di documentazione. Puoi espandere o chiudere la barra laterale.
Il pannello di sinistra funge da menu per il sito della documentazione. Puoi visualizzare le pagine all'interno del tuo sito di documentazione e utilizzarlo per creare gruppi e pagine nidificate. Puoi anche navigare nel sito utilizzando i link forniti.
Il pannello inferiore include pulsanti che sono vitali per il processo di controllo della versione. Puoi aggiungere un nome alla bozza, unire una modifica o inviare la modifica per la revisione.

Come creare una nuova bozza

Puoi creare una nuova bozza creando una nuova richiesta di modifica e apportando modifiche al suo interno.

Nel pannello superiore, fare clic su Cambia richieste .
Nel nuovo pannello che appare sul lato destro, fare clic su Brutta copia scheda. Questo ti mostrerà tutte le tue bozze attive.
Da qui, puoi fare clic su una bozza esistente per aprirla. Per creare una nuova bozza, fare clic su Nuova richiesta di modifica e attendi il completamento del caricamento della pagina.
Nel pannello in basso, fare clic su Inserisci un oggetto . Si aprirà una finestra in cui puoi dare un nome alla nuova bozza. Per esempio, Nuova pagina - Come impostare la base di codice .

Come creare pagine e gruppi

Una volta che hai una bozza, puoi iniziare a modificare la documentazione. GitBook memorizza le tue modifiche all'interno della bozza, in modo che non influiscano sulla copia master. Puoi utilizzare la barra laterale di sinistra per aggiungere pagine e gruppi di pagine.

Chrome usando molta memoria

Crea una nuova pagina cliccando su Nuova pagina collegamento nella parte inferiore della barra laterale e selezionando Nuova pagina del documento dal menu a discesa. In alternativa, puoi passare con il mouse sotto una pagina esistente e fare clic sul blu più pulsante.
Per creare un nuovo gruppo di pagine, fare clic su Nuova pagina e selezionare il Nuovo gruppo opzione dal menu a discesa.
Puoi rinominare la pagina facendo clic sui tre punti accanto alla pagina o al gruppo e selezionando Rinominare .
Inizia ad aggiungere contenuti per popolare la tua nuova pagina. Puoi aggiungere contenuti semplici come testo o intestazioni. GitBook ti consente anche di aggiungere altri blocchi di contenuto come immagini, allegati di file, tabelle, schede o frammenti di codice. C'è anche la possibilità di aggiungere altre integrazioni come incorporamenti di YouTube o contenuti di Google Docs.
Clicca sul Vista differenziale pulsante nel pannello inferiore per visualizzare le differenze tra la bozza e la copia della documentazione principale originale.
Una volta che hai finito di scrivere i tuoi contenuti, puoi fare clic su Unisci , Invia e unisci , o Invia per la revisione .

Come creare un collegamento al sito di documentazione

Puoi accedere al link di condivisione dal pannello superiore di GitBook. Sarà necessario essere fuori da una bozza e visualizzare la copia della documentazione principale per poter visualizzare il collegamento.

Per impostazione predefinita, la visibilità del tuo sito di documentazione è 'non elencata'. Ciò significa che puoi accedere al sito della documentazione utilizzando un link privato e non tramite i motori di ricerca. Nel pannello superiore, fare clic su Non elencato pulsante.
Seleziona le impostazioni di visibilità desiderate dal menu a discesa. Tieni presente che GitBook potrebbe bloccare determinate impostazioni di visibilità e potrebbe essere necessario eseguire l'aggiornamento per accedervi.
Sotto l'elenco delle impostazioni di visibilità, c'è un collegamento che puoi condividere con altri utenti che utilizzeranno il tuo sito di documentazione. Copia questo link per condividerlo con altri.
Sotto il collegamento, fare clic su Link e impostazioni del dominio . Qui è dove puoi collegare un nome di dominio personalizzato o modificare parte dell'URL. Se stai utilizzando un dominio personalizzato, puoi visualizzare La documentazione di Gitbook su come configurare correttamente il tuo DNS.

Creazione di documentazione utilizzando GitBook

GitBook ti consente di creare e lavorare in modo collaborativo su siti di documentazione o wiki aziendali. GitBook prende in prestito concetti da GitHub come rami e fusione per controllare una copia master e gestire eventuali conflitti.

Puoi creare una nuova bozza per aggiungere le tue modifiche individuali alla documentazione. All'interno della bozza, puoi apportare modifiche al contenuto, nonché aggiungere nuove pagine o gruppi di pagine. Una volta terminate le modifiche, puoi unirle o inviarle per la revisione.

Se stai creando documentazione interna per il tuo codice Java, potresti voler esplorare Javadoc. Javadoc ti consente di documentare automaticamente il tuo codice Java.