Com crear una wiki interna senzilla amb Gitbook

Com crear una wiki interna senzilla amb Gitbook

GitBook és una plataforma que permet crear llocs de documentació o wikis d'empresa. Podeu utilitzar-lo per documentar tot tipus de coses, des del codi fins a les API i com utilitzar un producte de programari.





GitBook utilitza un procés similar als repositoris de GitHub. La còpia principal de la documentació actua com a còpia 'mestra'. A continuació, podeu crear 'esborranys', que són similars a les 'branques'.



Aquest procés permet que molts usuaris treballin en un sol lloc de documentació mentre gestionen o prevenen conflictes. També permet que els canvis de diferents branques passin per un procés de revisió abans de combinar-los.





Com començar a utilitzar GitBook

Podeu triar entre diversos Preu de GitBook plans. El preu dependrà de si utilitzeu GitBook per a projectes de codi obert, ús personal o col·laboració en equip privat. GitBook és d'ús gratuït si l'utilitzeu per a projectes de codi obert.

Admet GitBook Markdown, un llenguatge de marques popular amb molts avantatges per escriure o documentar a la web.



com comprimir un fitxer de vídeo a Windows

GitBook també s'integra amb GitHub, una plataforma per allotjar, emmagatzemar i editar codi . Podeu enllaçar el vostre compte de GitBook directament al vostre compte de GitHub iniciant la sessió amb les vostres credencials de GitHub.

  1. Registra't a GitBook. Si teniu el vostre propi compte de GitHub, podeu fer clic a Registra't amb GitHub .
  2. Un cop hàgiu iniciat la sessió, GitBook us redirigirà a una nova wiki interna. També omplirà prèviament el vostre wiki amb algun contingut de mostra.

Una visió general de la interfície GitBook

GitBook té diverses funcions que us permeten crear i fer canvis al vostre lloc de documentació.



com trobar programes instal·lats a Windows 10
  1. El tauler superior us permet crear nous esborranys, veure l'historial de canvis o veure altres debats o fitxers adjunts.
  2. La barra lateral més a l'esquerra us permet crear diversos espais. Podeu utilitzar espais separats per a diferents projectes perquè pugueu separar i organitzar les vostres àrees de documentació. Podeu ampliar o tancar la barra lateral.
  3. El tauler esquerre actua com a menú per al lloc de documentació. Podeu veure les pàgines del vostre lloc de documentació i utilitzar-les per crear grups i pàgines imbricades. També podeu navegar pel lloc mitjançant els enllaços proporcionats.
  4. El tauler inferior inclou botons que són vitals per al procés de control de versions. Podeu afegir un nom a l'esborrany, combinar un canvi o enviar-lo per revisar-lo.

Com crear un nou esborrany

Podeu crear un esborrany nou creant una nova sol·licitud de canvi i fent-hi canvis.

  1. Al panell superior, feu clic a Sol·licituds de canvi .
  2. Al nou tauler que apareix a la part dreta, feu clic a Esborrany pestanya. Això us mostrarà tots els vostres esborranys actius.
  3. Des d'aquí, podeu fer clic a un esborrany existent per obrir-lo. Per crear un esborrany nou, feu clic a Nova sol·licitud de canvi , i espereu que la pàgina s'acabi de carregar.
  4. Al panell inferior, feu clic a Introduïu un tema . Això obrirà una finestra on podeu donar un nom al nou esborrany. Per exemple, Pàgina nova: com configurar la base de codi .

Com crear pàgines i grups

Un cop tingueu un esborrany, podeu començar a fer canvis a la documentació. GitBook emmagatzema els vostres canvis dins de l'esborrany, de manera que no afectin la còpia mestra. Podeu utilitzar la barra lateral esquerra per afegir pàgines i grups de pàgines.



  1. Creeu una pàgina nova fent clic a Pàgina nova enllaç a la part inferior de la barra lateral i seleccionant Nova pàgina del document del desplegable. Alternativament, podeu passar el cursor per sota d'una pàgina existent i fer clic al blau més botó.
  2. Per crear un grup de pàgines nou, feu clic a Pàgina nova , i seleccioneu Nou grup opció del menú desplegable.
  3. Podeu canviar el nom de la pàgina fent clic als tres punts al costat de la pàgina o del grup i seleccionant Canvia el nom .
  4. Comenceu a afegir contingut per omplir la vostra pàgina nova. Podeu afegir contingut senzill com ara text o encapçalaments. GitBook també us permet afegir altres blocs de contingut com ara imatges, fitxers adjunts, taules, pestanyes o fragments de codi. També hi ha l'opció d'afegir altres integracions, com ara incrustacions de YouTube o contingut de Google Docs.
  5. Feu clic a Vista diferent botó al tauler inferior per veure les diferències entre el vostre esborrany i la còpia de la documentació mestra original.
  6. Un cop hàgiu acabat d'escriure el vostre contingut, podeu fer clic Fusionar , Envia i fusiona , o Enviar per a revisió .

Podeu accedir a l'enllaç per compartir des del tauler superior de GitBook. Haureu d'estar fora d'un esborrany i veure la còpia de la documentació mestra per poder veure l'enllaç.

  1. Per defecte, la visibilitat del vostre lloc de documentació és 'no llistat'. Això vol dir que podeu accedir al lloc de documentació mitjançant un enllaç privat, i no mitjançant motors de cerca. Al panell superior, feu clic a No cotitzades botó.
  2. Seleccioneu la configuració de visibilitat desitjada al menú desplegable. Tingueu en compte que GitBook pot bloquejar determinats paràmetres de visibilitat i és possible que hàgiu d'actualitzar-los per accedir-hi.
  3. A sota de la llista de paràmetres de visibilitat, hi ha un enllaç que podeu compartir amb altres usuaris que faran servir el vostre lloc de documentació. Copia aquest enllaç per compartir-lo amb altres persones.
  4. A sota de l'enllaç, feu clic a Configuració d'enllaç i domini . Aquí és on podeu enllaçar un nom de domini personalitzat o modificar part de l'URL. Si utilitzeu un domini personalitzat, podeu visualitzar-lo Documentació de Gitbook sobre com configurar correctament el vostre DNS.

Creació de documentació amb GitBook

GitBook us permet crear i treballar en col·laboració en llocs de documentació o wikis d'empresa. GitBook pren en préstec conceptes de GitHub com ara branques i fusions per controlar una còpia mestra i gestionar qualsevol conflicte.

Podeu crear un esborrany nou per afegir els vostres propis canvis individuals a la documentació. Dins de l'esborrany, podeu fer canvis al contingut, així com afegir pàgines noves o grups de pàgines. Un cop hàgiu acabat de fer els vostres canvis, podeu combinar-los o enviar-los per revisar-los.

Si esteu creant documentació interna per al vostre codi Java, potser voldreu explorar Javadoc. Javadoc us permet documentar el vostre codi Java automàticament.