Improves Quick Start for users not using Linux #803

DougReeder · 2024-04-10T20:44:23Z

DougReeder commented

2024-04-10 20:44:23 +00:00

First-time contributor

Documents how to run in container on Quick Start page, for users not on Linux

DougReeder added 1 commit 2024-04-10 20:44:23 +00:00

ci/woodpecker/pr/debug Pipeline was successful Details

0c3b198b22 Improves Quick Start for users not using Linux

DougReeder referenced this pull request

2024-04-10 20:46:51 +00:00

Unclear how to troubleshoot connection to Docker image #801

DougReeder requested review from tixie 2024-04-11 14:41:32 +00:00

DougReeder requested review from lx 2024-04-11 14:41:54 +00:00

lx removed review request for tixie 2024-04-11 15:26:08 +00:00

lx requested changes 2024-04-12 17:03:46 +00:00

doc/book/quick-start/_index.md

					
				@ -111,6 +114,25 @@ garage -c path/to/garage.toml server

				If you have placed the `garage.toml` file in `/etc` (its default location), you can simply run `garage server`.

				To create a Docker container of Garage from an image, run:

lx commented

2024-04-12 17:03:35 +00:00

Reading this naively, it looks like we need to do BOTH launch garage server and create the docker container, which is not the case. Maybe reword with something like:

"Alternatively, if you cannot or do not wish to run the garage binary directly, you may use Docker to run Garage in a container using the following command:"

Reading this naively, it looks like we need to do BOTH launch `garage server` and create the docker container, which is not the case. Maybe reword with something like: "Alternatively, if you cannot or do not wish to run the garage binary directly, you may use Docker to run Garage in a container using the following command:"