From 153ed6a7b75abaf5a94ff022846bc2bbf4622b54 Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Thu, 2 Jan 2020 15:21:35 +0200
Subject: [PATCH] Update documentation
---
README.md | 4 ++--
docs/faq.md | 8 ++++----
docs/install_linux_mac.md | 14 +++++++-------
3 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 50dac8a..281be35 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ The ports 8080/8081/8008 must be available for the **trains-server** services.
For example, to see if port `8080` is in use:
-* Linux or Mac OS X:
+* Linux or macOS:
sudo lsof -Pn -i4 | grep :8080 | grep LISTEN
@@ -63,7 +63,7 @@ Launch **trains-server** in any of the following formats:
- Pre-built [AWS EC2 AMI](https://github.com/allegroai/trains-server/blob/master/docs/install_aws.md)
- Pre-built Docker Image
- [Linux](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md)
- - [Mac OS X](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md)
+ - [macOS](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md)
- [Windows 10](https://github.com/allegroai/trains-server/blob/master/docs/install_win.md)
- Kubernetes
- [Kubernetes Helm](https://github.com/allegroai/trains-server-helm#prerequisites)
diff --git a/docs/faq.md b/docs/faq.md
index a9a8f88..ac5efb8 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -6,7 +6,7 @@ Launching **trains-server**
* [Stand alone Linux Ubuntu systems?](#ubuntu)
- * [Mac OS X?](#mac-osx)
+ * [macOS?](#mac-osx)
* [Windows 10?](#docker_compose_win10)
@@ -72,11 +72,11 @@ To launch **trains-server** on a stand alone Linux Ubuntu:
Your server is now running on [http://localhost:8080](http://localhost:8080)
-### How do I launch trains-server on Mac OS X?
+### How do I launch trains-server on macOS?
-To launch **trains-server** on Mac OS X:
+To launch **trains-server** on macOS:
-1. Install [docker for OS X](https://docs.docker.com/docker-for-mac/install/).
+1. Install [docker for macOS](https://docs.docker.com/docker-for-mac/install/).
1. Configure [Docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode).
diff --git a/docs/install_linux_mac.md b/docs/install_linux_mac.md
index 3ed7684..7b20019 100644
--- a/docs/install_linux_mac.md
+++ b/docs/install_linux_mac.md
@@ -1,18 +1,18 @@
-# Launching the **trains-server** Docker in Linux or Mac OS X
+# Launching the **trains-server** Docker in Linux or macOS
-For Linux or Mac OS X, use our pre-built Docker image for easy deployment. The latest Docker images can be found [here](https://hub.docker.com/r/allegroai/trains).
+For Linux or macOS, use our pre-built Docker image for easy deployment. The latest Docker images can be found [here](https://hub.docker.com/r/allegroai/trains).
For Linux users:
* You must be logged in as a user with sudo privileges.
* Use `bash` for all command-line instructions in this installation.
-To launch **trains-server** on Linux or Mac OS X:
+To launch **trains-server** on Linux or macOS:
1. Install Docker.
* Linux - see [Docker for Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
- * Mac OS X - see [Docker for OS X](https://docs.docker.com/docker-for-mac/install/).
+ * macOS - see [Docker for macOS](https://docs.docker.com/docker-for-mac/install/).
1. Verify the Docker CE installation. Execute the command:
@@ -43,7 +43,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo sysctl -w vm.max_map_count=262144
sudo service docker restart
- Mac OS X:
+ macOS:
screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
sysctl -w vm.max_map_count=262144
@@ -65,7 +65,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo mkdir -p /opt/trains/config
sudo mkdir -p /opt/trains/data/fileserver
-1. For Mac OS X only, open the Docker app, select **Preferences**, and then on the **File Sharing** tab, add `/opt/trains`.
+1. For macOS only, open the Docker app, select **Preferences**, and then on the **File Sharing** tab, add `/opt/trains`.
1. Grant access to the Dockers.
@@ -73,7 +73,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo chown -R 1000:1000 /opt/trains
- Mac OS X:
+ macOS:
sudo chown -R $(whoami):staff /opt/trains