Deuxfleurs/garage
47
55
Fork 71
Code Issues 98 Pull requests 14 Releases 30 Wiki Activity

Improves Quick Start for users not using Linux #803

Closed
DougReeder wants to merge 0 commits from DougReeder/garage:main into main
pull from: DougReeder/garage:main
merge into: Deuxfleurs:main
Conversation 2 Commits - Files changed - +25
DougReeder commented 2024-04-10 20:44:23 +00:00
First-time contributor
Copy link

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

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
Improves Quick Start for users not using Linux
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
0c3b198b22
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
Owner
Copy link

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:"
lx commented 2024-05-24 17:13:17 +00:00
Owner
Copy link

Ping @DougReeder

Otherwise I'll do the rephrasing myself eventually

Ping @DougReeder Otherwise I'll do the rephrasing myself eventually
maximilien added this to the v1.1 milestone 2024-08-06 21:46:32 +00:00
lx was assigned by maximilien 2024-08-06 21:46:38 +00:00
maximilien added the
scope
documentation
kind
usability
 labels 2024-08-07 21:53:08 +00:00
lx commented 2024-08-24 11:06:28 +00:00
Owner
Copy link

Replaced by #862

Replaced by #862
lx closed this pull request 2024-08-24 11:06:28 +00:00
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Required
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
lx
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
v1.1
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
lx
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#803
No description provided.
Delete branch "DougReeder/garage:main"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?