Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Address quickstart guide issues #276

Merged
merged 5 commits into from
Aug 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
2 changes: 2 additions & 0 deletions docs/developer/agents.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _agents:

Agents
======

Expand Down
13 changes: 10 additions & 3 deletions docs/user/docker_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ section of this documentation. An example `docker-compose.yaml` file looks
something like this (note this does not contain all possibly configured
components)::

version: '2'
version: '3.7'
volumes:
grafana-storage:

services:
# --------------------------------------------------------------------------
# Grafana for the live monitor.
Expand All @@ -36,7 +39,7 @@ components)::
ports:
- "127.0.0.1:3000:3000"
volumes:
- /srv/grafana:/var/lib/grafana
- grafana-storage:/var/lib/grafana

# InfluxDB Backend for Grafana
influxdb:
Expand All @@ -45,6 +48,8 @@ components)::
restart: always
ports:
- "8086:8086"
volumes:
- /srv/influxdb:/var/lib/influxdb

# --------------------------------------------------------------------------
# Crossbar
Expand Down Expand Up @@ -239,14 +244,16 @@ Where the separate compose files would look something like::
default:
external:
name: ocs-net
volumes:
grafana-storage:
services:
grafana:
image: grafana/grafana:latest
restart: always
ports:
- "127.0.0.1:3000:3000"
volumes:
- /srv/grafana:/var/lib/grafana
- grafana-storage:/var/lib/grafana

::

Expand Down
18 changes: 10 additions & 8 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _installation:
.. _ocs_install:

Installation
============
Expand All @@ -8,7 +8,9 @@ Installing Docker

Docker is used to run many of the components in the live monitor. While the
system can be run without Docker, it is the recommended deployment option. To
install, please follow the `installation`_ documentation on the Docker website.
install, please follow the `installation
<https://docs.docker.com/engine/install/ubuntu/>`_ documentation on the Docker
website.

.. note::

Expand Down Expand Up @@ -59,12 +61,12 @@ To install, clone the repository and use pip to install::

git clone https://github.com/simonsobs/ocs.git
cd ocs/
pip3 install -r requirements.txt .
pip install -r requirements.txt .

.. note::

If you want to install locally, not globally, throw the `--user` flag
on both the pip3 and setup.py commands.
when installing with pip.

.. _Docker Compose: https://docs.docker.com/compose/install/

Expand All @@ -81,15 +83,15 @@ container.
The OCS user, `ocs`, has a UID of 9000, and a matching group, also called
`ocs`, with a GID of 9000. To create the group and user run::

$ groupadd -g 9000 ocs
$ useradd -u 9000 -g 9000 ocs
$ sudo groupadd -g 9000 ocs
$ sudo useradd -u 9000 -g 9000 ocs

Next we need to create the data directory which the aggregator will write files
to. This can be any directory, for example, ``/data``, which we will use
throughout this documentation::

$ mkdir /data
$ chown 9000:9000 /data
$ sudo mkdir /data
$ sudo chown 9000:9000 /data

Finally, we should add the current user account to the `ocs` group, replace
`user` with your current user::
Expand Down
Loading