Commit graph

27 commits

Author SHA1 Message Date
0c3b198b22 Improves Quick Start for users not using Linux 2024-04-10 16:42:10 -04:00
0038ca8a78
Merge branch 'main' into next-0.10 2024-03-18 20:19:30 +01:00
a7dddebedd
[doc-updates] doc: be slightly more critical of LMDB 2024-03-14 16:31:22 +01:00
Yureka
8f86af52ed adjust docs for replication factor 2024-03-05 22:57:08 +01:00
73b11eb17c
[doc-default-token] add default metrics_token in quick start + uniformize use of base64 2024-02-29 13:17:36 +01:00
292f4ff9cb Typo
Fix small typo on the getting started guide
2024-02-20 18:35:56 +00:00
c86ac264cb
doc: mention warn and error as available log levels
For some users, this might be their first time being interacting with
the `env_logger` crate.
As such, they might not be aware that less verbose log levels exist.
Some might not want to log every incoming request, for example.

This commit also adds syntax hints to the code-fence for bash for better
syntax highlighting of that section, and repeats itself multiple times,
that `info` is, in fact, the default.

No changes to the recommendation of log levels were made.
2024-02-12 18:00:51 +01:00
d24aaba697 doc: update quick start and real world for v0.9.0 2023-10-11 14:49:54 +02:00
2e656b541b Merge branch 'main' into next 2023-10-03 18:40:37 +02:00
cb359b4434 doc: update endpoint_url documentation
Since `awscli` `>=1.29.0` or `>=2.13.0` it is now possible to use the
`AWS_ENDPOINT_URL` environment variable, or the `endpoint_url` config
key to override the endpoint URL. This means, the aws bash function to
wrap with --endpoint-url is not necessary anymore. Update invocations to
reflect that.

https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html
https://github.com/aws/aws-cli/issues/4454#issuecomment-1626116607
2023-10-02 17:16:11 +03:00
2e90e1c124 Merge branch 'main' into next 2023-08-29 11:32:42 +02:00
51011e68b1 move alpine linux info to binary package page 2023-08-28 12:20:34 +02:00
a54a1f5616 Merge pull request 'doc: Add information about Alpine Linux package to Quick Start' (#564) from jirutka/garage:alpine into next-0.8
Reviewed-on: Deuxfleurs/garage#564
2023-08-28 10:18:33 +00:00
187240e539 Merge branch 'main' into next 2023-06-14 13:02:46 +02:00
dd7533a260 doc: add an operations&maintenance section and move some pages there 2023-06-14 12:39:40 +02:00
06caa12d49 doc: Add information about Alpine Linux package to Quick Start 2023-05-07 19:28:43 +02:00
fa78d806e3 Merge branch 'main' into next 2023-04-25 12:34:26 +02:00
a2a35ac7a8 docs(book/quickstart): adapt aws s3 commands to example
Signed-off-by: arthurlutz <arthurlutz@noreply.localhost>
2023-04-03 06:18:28 +00:00
Jonathan Davies
8be862aa19 Changed all instances of 'key new' to 'key create' to make it consistent as bucket commands issued normally around the same time. 2023-01-03 11:11:12 +00:00
a7af0c8af9
Add best practices and doc of monitoring (fix #419) 2022-11-16 13:27:24 +01:00
cf23aee183
Add a "build" section, doc for SDK 2022-11-13 16:48:52 +01:00
a976c9190c
Use awscli in the getting started guide 2022-11-11 12:48:52 +01:00
f6aebefcc9
Some work on documentation towards v0.8 2022-09-14 19:31:13 +02:00
a1abed0378
Remove useless MC_REGION env variable 2022-06-02 12:50:11 +02:00
4ae03aa774 Small documentation updates (#237)
Fixes #234, among other things

Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: Deuxfleurs/garage#237
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
2022-02-10 15:58:09 +01:00
99ed67503c
Update quickstart to set endpoints ending in localhost 2022-02-07 16:01:48 +01:00
1c0ba930b8 Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.

- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization

Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: Deuxfleurs/garage#213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
2022-02-07 11:51:12 +01:00
Renamed from doc/book/src/quick_start/index.md (Browse further)