How to Create a Simple Internal Wiki Using GitBook
GitBook is a platform that allows you to build documentation sites or company wikis. You can use it to document all kinds of things, from code to APIs and how to use a software product.
GitBook uses a similar process to GitHub repositories. The main copy of the documentation acts as a “master” copy. You can then create “drafts”, which are similar to “branches”.
This process allows many users to work on a single documentation site while handling or preventing conflicts. It also allows changes from different branches to go through a review process before you merge them.
How to Start Using GitBook
You can choose from severalGitBook pricingplans. Pricing will depend on whether you are using GitBook for open source projects, personal use, or private team collaboration. GitBook is free to use if you are using it for open source projects.
GitBook supportsMarkdown, a popular markup language with many benefitsfor writing or documenting on the web.
GitBook also integrates withGitHub, a platform for hosting, storing, and editing code. You can link your GitBook account directly to your GitHub account by signing in using your GitHub credentials.
An Overview of the GitBook Interface
GitBook has several functions that allow you to build and make changes to your documentation site.
How to Create a New Draft
You can create a new draft by creating a new Change Request and making changes within it.
How to Create Pages and Groups
Once you have a draft, you can start making changes to the documentation. GitBook stores your changes inside the draft, so they do not affect the master copy. You can use the left-hand sidebar to add pages and page groups.
How to Create a Link to the Documentation Site
You can access the share link from the top panel of GitBook. You will need to be out of a draft and viewing the master documentation copy to be able to view the link.
Creating Documentation Using GitBook
GitBook allows you to collaboratively create and work on documentation sites or company wikis. GitBook borrows concepts from GitHub like branches and merging to control a master copy and manage any conflicts.
You can create a new draft to add your own individual changes to the documentation. Within the draft, you can make changes to the content, as well as add new pages or page groups. Once you have finished making your changes, you can either merge them or submit them for review.
If you are creating internal documentation for your Java code, you may want to explore Javadoc. Javadoc allows you to document your Java code automatically.
Learn all about the built-in tool that can handle the toughest bits of documentation writing for you.
The key is not to spook your friends with over-the-top shenanigans.
OneDrive is one of the best, but it has a catch.
I plugged random USB devices into my phone and was pleasantly surprised by how many actually worked.
Now, I actually finish the books I start.
It’s not super flashy, but it can help to keep your computer up and running.
