Deuxfleurs/garage
41
56
Fork 73
Code Issues 99 Pull requests 14 Releases 30 Wiki Activity

Add a mdbook documentation to present garage and help user on-boarding #45

Merged
lx merged 9 commits from feature/mdbook into master 2021-03-18 09:39:59 +00:00
Conversation 1 Commits 9 Files changed 25 +784 -257
quentin commented 2021-03-17 21:59:46 +00:00
Owner
Copy link

The documentation has been published here: https://garagehq.deuxfleurs.fr

It is a first draft and it will need to be improved over time of course.
Feel free to directly fix all the typos you see directly in the branch.
Ideally the website would be updated through the CI on each commit.

The documentation has been published here: https://garagehq.deuxfleurs.fr It is a first draft and it will need to be improved over time of course. Feel free to directly fix all the typos you see directly in the branch. Ideally the website would be updated through the CI on each commit.
quentin added 9 commits 2021-03-17 21:59:49 +00:00
Doc skeleton + intro
All checks were successful
continuous-integration/drone/push Build is passing
Details
0afc701a69
Work on structure + Getting started is reworked
All checks were successful
continuous-integration/drone/push Build is passing
Details
c50113acf3
Refactor file organization
All checks were successful
continuous-integration/drone/push Build is passing
Details
002538f92c
Working on the getting started guide
All checks were successful
continuous-integration/drone/push Build is passing
Details
60f994a118
WIP doc
All checks were successful
continuous-integration/drone/push Build is passing
Details
468e45ed7f
Wrote daemon
Some checks failed
continuous-integration/drone/push Build is failing
Details
44d0815ff9
Simplify our README
All checks were successful
continuous-integration/drone/push Build is passing
Details
b82a61fba2
WIP getting started
All checks were successful
continuous-integration/drone/push Build is passing
Details
1a5af9d1fc
Add handle files section to the doc
Some checks reported errors
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build was killed
Details
ea21c54434
lx commented 2021-03-18 09:39:50 +00:00
Owner
Copy link

Thank you!

Thank you!
lx merged commit 5b659b28ce into master 2021-03-18 09:39:59 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
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
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
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#45
No description provided.
Delete branch "feature/mdbook"

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?