simonsobs / simonsobs/ocs

Write documentation on installation without Docker

Open
#277 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
19
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Some users would like to avoid using Docker. We should include a section in the docs on how to do this if needed. This could be like the quickstart guide, or just a page on what's different (and instructions on how to do things that aren't yet documented, i.e. "install influxdb", "install grafana" -- though I expect those will just be links to those packages respective installation pages.)

I'm not totally sure where we'll put the new page yet. It could also just be a page under System Configuration titled "Dockerless Configuration" or similar, but the preceding installation pages still of course mention installing docker. Maybe we need an "Advanced Configurations" page that's called out during the Installation page? Suggestions on how to split this up definitely welcome.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Installation pages, the Quickstart guide, and the System Configuration documentation to identify Docker-specific steps and missing non-Docker instructions. Decide whether the work belongs in a Dockerless Configuration page or an Advanced Configurations section, then document installing InfluxDB and Grafana, linking to their installation pages where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.