The Tools We Use For Ampersand
  • Introduction
  • Tools used in the Ampersand project
  • Version control with Git
  • How to release an Ampersand upgrade
  • Documenting with GitBook
    • Getting started with GitBook
    • Do's and Dont's in Ampersand documentation
  • Building
    • Building an Ampersand Compiler with Stack
    • Baking a Docker image that contains the Ampersand Compiler
    • Testing with Docker on your own laptop
    • Automated builds
  • Prototype framework
  • Automation of releasing (CI/CD)
    • Github packages
  • Installation of RAP
    • Deploying to your own laptop
    • Deploying RAP4 in the Azure cloud
    • Deploying OUNL RAP4
    • Maintaining RAP4
    • Making Docker images
    • Deployment Configuration
    • Details
  • Functionality of RAP4
    • Student
    • Tutor
    • Account Manager
    • Graduate Student
  • Deploying with Kubernetes
  • Authentication and access management with OAuth
  • Ampersand language support
  • Group 1
    • Development using VS Code
Powered by GitBook
On this page
  • Getting started with GitBook
  • The GitBook Web Editor
  • The GitBook desktop client
Export as PDF
  1. Documenting with GitBook

Getting started with GitBook

PreviousDocumenting with GitBookNextDo's and Dont's in Ampersand documentation

Last updated 7 years ago

Getting started with GitBook

If you want to add to the documentation, it is possible to update the repository with any tool you like. However, we strongly advise to use the GitBook editor. A lot of cumbersome work is automated for you. Here are the steps to get on your way:

  • Create an account at .

  • Once you have an account get in touch with so he can grant you access to the book(s) you want to contribute to.

  • You will automatically find the books at your , where you will find a button to start editing the book.

The GitBook Web Editor

The editor explains itself. At GitBook, they eat their own dogfood to write .

The GitBook desktop client

Recently, Gitbook also has a desktop client. It can be found When you install this desktop client, GitBook will make a local clone of the book. You will find it at ~home/Gitbook. As far as I know, this is not configurable, so you'll just have to deal with it. You can synchronize from within gitbook. However, if it gets a little bit complicated, I prefer sourcetree to give the correct git commands.

Gitbook
Han Joosten
Gitbook dashboard
GitBook Documentation
here.