Commit 37a9dac4 authored by Kristina Hoeppner's avatar Kristina Hoeppner
Browse files

Update Readme file to correct spellings and headings

parent a65bfc51
......@@ -7,27 +7,29 @@ The Mahara Manual is:
- with a docker builder
# Quickstart
# Quick start
Run one of the commands below from the main folder to build the docs.
The first command only builds English. The second builds all translations
(and takes longer).
Run one of the commands below from the main folder to build the Mahara manual.
The first command update the Docker image. The second command only builds the
English translation. The third command builds all translations (and takes
longer).
```
# build/update the dockerized manual builder
manual-build/build-builder.sh
# build english manual for current branch
# build English manual for current branch
manual-build/build-manual.sh TRANSLATIONS=en html
# build all translations for current branch
manual-build/build-manual.sh html
# check your changes on a site served from the local server
manual-build/local-server.sh start
# check your changes in site served from the local server
# stop the local server
manual-build/local-server.sh stop
```
The built docs will be in the `build/html` directory (on your host machine).
The built manual will be in the `build/html` directory on your local machine.
Run the following command from the main folder to generate the potfiles needed
to allow for translations.
......@@ -38,34 +40,32 @@ to allow for translations.
It will create a folder `potfiles`.
## Pre-requisites
### Docker docbuilder
# Pre-requisites: Docker docbuilder
[Docker](https://docker.com) needs to be available on your workstation.
If Docker is not already available it needs to be installed and configured before
you continue.
If Docker is not already available it needs to be installed and configured
before you continue.
If docker is available you can build the docbuilder image on Linux with:
If Docker is available you can build the docbuilder image on Linux with:
```
./manual-build/build-builder.sh
```
Note: this command should be run periodically to freshen up (patch) the builder
Note: This command should be run periodically to freshen up (patch) the builder
image.
The `mahara/docbuilder` image is based on a debian docker image with additional
packages that are required for building the docs installed. Using a docker image
The `mahara/docbuilder` image is based on a Debian docker image with additional
packages that are required for building the manual. Using a Docker image
for this makes it easy to get going with the same build environment as used by
mahara.org.
The image is also made so that the default user has the same UID:GID as the current
system user. This is so that the built files are owned by the current user on the
host machine(otherwise they might be owned by root).
The image is also made so that the default account has the same UID:GID as the
current system account. This is so that the built files are owned by the
current account on the host machine. Otherwise they might be owned by root.
## Docbuilder @ manual.mahara.org
# Docbuilder @ manual.mahara.org
manual.mahara.org uses this project as a sub module to make use of the same doc
builder. So any changes to how the doc builder is created need to be applied to
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment