mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 07:18:06 +02:00
Code Activity

Consistent caps

Browse source
This commit is contained in:
Christopher Hoskin 2021-04-27 12:15:48 +01:00
parent b27c7f3809
commit 46146a69c7
5 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/dependencies.md
View file

@ -13,4 +13,4 @@ with `brew install coreutils`, to get a working version of `realpath`.
## Host Environment
The Overleaf toolkit is tested on Ubuntu Linux, but we expect that most modern Linux systems will be able to run the toolkit without problems. Although it is possible to run the toolkit on other platforms, they are not officially supported.
The Overleaf Toolkit is tested on Ubuntu Linux, but we expect that most modern Linux systems will be able to run the toolkit without problems. Although it is possible to run the toolkit on other platforms, they are not officially supported.

2
doc/docker-compose.md
View file

@ -1,6 +1,6 @@
# Working with Docker-Compose Services
The Overleaf toolkit runs Overleaf inside a docker container, plus the
The Overleaf Toolkit runs Overleaf inside a docker container, plus the
supporting databases (MongoDB and Redis), in their own containers. All of this
is orchestrated with `docker-compose`.

2
doc/persistent-data.md
View file

@ -1,6 +1,6 @@
# Persistent Data Overview
The Overleaf toolkit needs to store persistent data, such as the files required to compile LaTeX projects, and the contents of the MongoDB database. This is achieved by mounting a few directories from the host machine into the docker containers, and writing the data to those directories.
The Overleaf Toolkit needs to store persistent data, such as the files required to compile LaTeX projects, and the contents of the MongoDB database. This is achieved by mounting a few directories from the host machine into the docker containers, and writing the data to those directories.
## Data Directories

4
doc/quick-start-guide.md
View file

@ -2,7 +2,7 @@
## Prerequisites
The overleaf toolkit depends on the following programs:
The Overleaf Toolkit depends on the following programs:
- bash
- docker
@ -76,7 +76,7 @@ These are the three configuration files you will interact with:
## Starting Up
The overleaf toolkit uses `docker-compose` to manage the overleaf docker containers. The toolkit provides a set of scripts which wrap `docker-compose`, and take care of most of the details for you.
The Overleaf Toolkit uses `docker-compose` to manage the overleaf docker containers. The toolkit provides a set of scripts which wrap `docker-compose`, and take care of most of the details for you.
Let's start the docker services:

2
doc/the-doctor.md
View file

@ -1,6 +1,6 @@
# The Doctor
The Overleaf toolkit comes with a handy `doctor` script, to help with debugging. Just run `bin/doctor` and the script will print out information about your host environment, your configuration, and the dependencies the toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation.
The Overleaf Toolkit comes with a handy `doctor` script, to help with debugging. Just run `bin/doctor` and the script will print out information about your host environment, your configuration, and the dependencies the toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation.
## Getting Help