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
  • Do's and don'ts
  • Every commit in the origin/master branch is built.
  • A reference can only be made to an article.
  • Referencing is done to relative locations.
Export as PDF
  1. Documenting with GitBook

Do's and Dont's in Ampersand documentation

PreviousGetting started with GitBookNextBuilding

Last updated 6 years ago

Do's and don'ts

Every commit in the origin/master branch is built.

If you prefer the web editor, know that each time the master branch is committed, the book is generated. While we are in draft, it is recommended to use a separate branch to do the writing. This prevents too many commits in the github repo master, as each time you save your work in the editor, a commit is done. If you use the , this is far less a problem, because you only synchronize when you made some more changes.

A reference can only be made to an article.

As far as I know, a reference can only be made to something written down in an article, i.e. a separate file. Therefore, it is a good habit to focus on exactly one thing you want to explain/write about in every file.

Referencing is done to relative locations.

If you want to refer to another article, that can be done by using a relative path. Like I have done with this link to It is probably a good habit to check that the links work, by checking the book as it is generated.

desktop client
Getting started with gitbook.