summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames E. Blair <jim@acmegating.com>2021-07-26 10:29:08 -0700
committerJames E. Blair <jim@acmegating.com>2021-07-26 10:29:08 -0700
commitb24819779ed9d0ff7dbfbeacb87469e4e0d4c1d6 (patch)
tree6301755d9fead962a258a166c0e4a876aa7aa0f2
parenta181dc5da74ffdb931c85199af1a9a3e9fd28704 (diff)
downloadzuul-b24819779ed9d0ff7dbfbeacb87469e4e0d4c1d6.tar.gz
Update tutorial instructions with RAM requirement
It looks like we need 2GB of ram; mention that as a requirement. Also, add a "sudo apt-get update" command for Ubuntu/Debian users; with this, a user should get a working system from a pristine VM using only and exactly the commands specified. Change-Id: Ife48afbd6326b8d8e774b4227fbe6523d3aed81e
-rw-r--r--doc/source/tutorials/quick-start.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/tutorials/quick-start.rst b/doc/source/tutorials/quick-start.rst
index b5c3b26af..c9d4dff1e 100644
--- a/doc/source/tutorials/quick-start.rst
+++ b/doc/source/tutorials/quick-start.rst
@@ -11,8 +11,8 @@ walk through setting up a basic gating configuration which protects
projects from merging broken code.
This tutorial is entirely self-contained and may safely be run on a
-workstation. The only requirements are a network connection and the
-ability to run Docker containers.
+workstation. The only requirements are a network connection, the
+ability to run Docker containers, and at least 2GiB of RAM.
This tutorial supplies a working Gerrit for code review, though the
concepts you will learn apply equally to GitHub.
@@ -49,6 +49,7 @@ Before you start, ensure that some needed packages are installed.
# Ubuntu / Debian:
+ sudo apt-get update
sudo apt-get install docker-compose docker.io git python3-pip
sudo python3 -m pip install git-review