Comment créer un wiki interne simple avec Gitbook

GitBook est une plateforme qui permet de créer des sites de documentation et de référence ou des wikis d'entreprise. Vous pouvez l'utiliser pour documenter toutes sortes de choses, du code aux API et à la manière dont le produit d'application est utilisé.

GitBook utilise un processus similaire aux référentiels GitHub. La copie maîtresse des documents fait office de copie « maître ». Vous pouvez ensuite créer des « brouillons » qui ressemblent à des « branches ». Vérifier Meilleures applications de base de connaissances pour votre organisation.

1gfdwL8bxJcZwpYsKEDKv avec DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Ce processus permet à plusieurs utilisateurs de travailler dans un emplacement d'authentification unique tout en gérant ou en prévenant les conflits. Cela permet également aux modifications de différentes branches de passer par un processus de révision avant de les fusionner.

Comment démarrer avec GitBook

Un wiki est un site Web conçu pour que des groupes de personnes obtiennent et partagent rapidement des idées en créant des pages simples et en les reliant. Votre entreprise peut utiliser un wiki pour diverses raisons. À grande échelle, vous pouvez partager de grandes quantités d'informations dans la base de connaissances d'une organisation. À plus petite échelle, vous pouvez utiliser un wiki d'équipe pour rassembler et partager rapidement des idées sur un projet.

Vous pouvez choisir parmi de nombreux Plans tarifaires GitBook. Le prix dépendra de si vous utilisez GitBook pour des projets open source, un usage personnel ou une collaboration d'équipe privée. GitBook est gratuit si vous l'utilisez pour des projets open source.

GitBook prend en charge la langue Markdown , un langage de balisage populaire qui présente de nombreux avantages pour l'écriture ou la documentation sur le Web.

GitBook s'intègre également à GitHub, une plate-forme d'hébergement, de stockage et d'édition de code. Vous pouvez lier votre compte GitBook directement à votre compte GitHub en vous connectant avec vos identifiants GitHub.

  • Commencez avec un abonnement GitBook. Si vous avez un compte GitHub, vous pouvez cliquer sur S'inscrire avec GitHub.

1g7rmfLIT cGp 0nmJYpwvg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Une fois connecté, GitBook vous redirigera vers un nouveau wiki interne. Il pré-remplira également le wiki avec un échantillon de contenu.

1fzqjMJ56b4v6zhX1Gpk3xg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Présentation de l'interface GitBook

GitBook contient de nombreuses fonctions qui vous permettent de créer votre propre site de documentation et d'y apporter des modifications.

  • Le panneau supérieur vous permet de créer de nouveaux brouillons, d'afficher l'historique des modifications ou d'afficher d'autres discussions ou pièces jointes.

1vsrx8x9JpTlRh0XUenX8bg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • La barre latérale à l'extrême gauche vous permet de créer plusieurs zones. Vous pouvez utiliser des espaces séparés pour différents projets afin de pouvoir séparer et organiser vos zones de documentation. Vous pouvez développer ou fermer la barre latérale.

1dCwLktBgE1t5PrVCP1sRog DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Le panneau de gauche agit comme une liste du site de documentation. Vous pouvez afficher les pages de votre site de documentation et les utiliser pour créer des groupes et des pages imbriqués. Vous pouvez également naviguer sur le site en utilisant les liens fournis.

1tI3dpcRN2Qli03vtsxZUGg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Le panneau inférieur comprend des boutons essentiels au fonctionnement du contrôle de version. Vous pouvez ajouter un nom à votre brouillon, incorporer une modification ou soumettre la modification pour examen.

123d8RCC6n ZTvnHfiiXkhw DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Comment créer un nouveau brouillon

Vous pouvez créer un nouveau brouillon en créant une nouvelle demande de modification et en y apportant des modifications.

  • Dans le panneau supérieur, appuyez sur Changer les commandes.

1 cZFqp8J9TG3kR4AWKLFw DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Dans le nouveau panneau qui apparaît sur le côté droit, cliquez sur l'onglet ébauche. Cela vous montrera tous vos brouillons actifs.

1CYFt 4BdSOqRfitaDd18SQ DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • À partir de là, vous pouvez cliquer sur un brouillon existant pour l'ouvrir. Pour créer un nouveau brouillon, cliquez sur Demander une nouvelle modification et attendez que la page finisse de se charger.
  • Dans le panneau inférieur, appuyez sur Entrez le sujet. Cela ouvrira une fenêtre où vous pourrez nommer le nouveau brouillon. Par exemple, Nouvelle page — Comment configurer Codebase.

1nHhcaUdVRM0q8WgLmZPLug DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Comment créer des pages et des groupes

Une fois que vous avez un brouillon, vous pouvez commencer à apporter des modifications à la documentation. GitBook stocke vos modifications dans le brouillon, afin qu'elles n'affectent pas la copie principale. Vous pouvez utiliser la barre latérale gauche pour ajouter des pages et des groupes de pages.

  • Créez une nouvelle page en cliquant sur le lien nouvelle page Sous la barre latérale, choisissez Nouvelle page de document dans le menu déroulant. Alternativement, vous pouvez faire défiler une page existante et cliquer sur le bouton bleu plus.

1lUWC0Qm x5J0RnYhRGkCUg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Pour créer un nouveau groupe de pages, appuyez sur nouvelle page , Et sélectionnez une option Nouveau groupe Dans le menu déroulant.

14SKvpzA5li ot42Nf 2gAg DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Vous pouvez renommer la page en cliquant sur le bouton Plus (les trois points) à côté de la page ou du groupe et en sélectionnant Renommer.

1kMSitavuU6Va7xoGRBEppQ DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Commencez à ajouter du contenu pour remplir votre nouvelle page. Vous pouvez ajouter du contenu simple comme du texte ou des titres. GitBook vous permet également d'ajouter d'autres blocs de contenu tels que des images, des pièces jointes, des tableaux, des onglets ou des extraits de code. Il existe également une option pour ajouter d'autres intégrations telles que l'intégration de contenu YouTube ou Google Docs.

1OkrFlm9sRIXXcL91qfwW3A DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Cliquez sur le bouton Vue différentielle dans le panneau inférieur pour afficher les différences entre le brouillon et la documentation principale d'origine.

1KJsdhVp9L84IPjkRTGnOGA DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Une fois que vous avez fini de rédiger votre contenu, vous pouvez cliquer sur Fusionner ou Envoyer et fusionner ou Soumettre pour correction.

1E z2dELeuOvVdAy0o9hDAA DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Comment créer un lien vers un wiki

Vous pouvez accéder au lien de partage depuis le panneau supérieur de GitBook. Vous devrez quitter le brouillon et afficher la documentation principale pour pouvoir afficher le lien.

  • Par défaut, votre site d'authentification apparaît comme "Non listé". Cela signifie que vous pouvez accéder au site de documentation en utilisant un lien spécial, et non via des moteurs de recherche. Dans le panneau supérieur, cliquez sur le bouton Non répertorié.
  • Sélectionnez les paramètres de visibilité souhaités dans la liste déroulante. Notez que GitBook peut verrouiller certains paramètres de visibilité et que vous devrez peut-être effectuer une mise à niveau pour y accéder.

13vON50ibtSyccvP2laJR4A DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

  • Sous le menu des paramètres de visibilité, il y a un lien que vous pouvez partager avec d'autres utilisateurs qui utiliseront votre wiki. Copiez ce lien pour le partager avec d'autres.
  • Sous le lien, cliquez sur Paramètres du lien et du domaine. C'est ici que vous pouvez créer un lien vers un nom de domaine personnalisé ou modifier une partie de l'URL. Si vous utilisez un domaine personnalisé, vous pouvez consulter la documentation de Gitbook sur Comment configurer votre DNS Correctement.

1ldVPpclwnqvw5LJ E bXbw DzTechs | Comment créer un wiki interne simple à l'aide de Gitbook

Créer un wiki avec GitBook

GitBook vous permet de créer et de travailler sur des sites de documents ou des wikis d'entreprise de manière collaborative. GitBook emprunte des concepts à GitHub tels que les branches et les fusionne pour contrôler une copie maîtresse et gérer les éventuels conflits.

Vous pouvez créer un nouveau brouillon pour ajouter vos modifications individuelles aux documents. Dans le brouillon, vous pouvez apporter des modifications au contenu, ainsi qu'ajouter de nouvelles pages ou groupes de pages. Une fois que vous avez terminé d'apporter des modifications, vous pouvez soit les fusionner, soit les soumettre pour examen.

Si vous créez une documentation interne pour votre code Java, vous pouvez explorer Javadoc. Javadoc vous permet de documenter votre code Java automatiquement. Vous pouvez désormais visualiser Comment créer votre propre wiki.

DzTech

Je suis ingénieur d'état avec une vaste expérience dans les domaines de la programmation, de la création de sites internet, du référencement et de la rédaction technique. Je suis passionné par la technologie et me consacre à fournir des informations de qualité au public. Je peux devenir une ressource plus précieuse pour les utilisateurs qui recherchent des informations précises et fiables sur les critiques de produits et les applications spécialisées dans divers domaines. Mon engagement inébranlable envers la qualité et l’exactitude garantit que les informations fournies sont dignes de confiance et utiles au public. La recherche constante de connaissances me pousse à me tenir au courant des dernières évolutions technologiques, en veillant à ce que les idées partagées soient véhiculées de manière claire et accessible.
Aller au bouton supérieur