📝(project) correct minor issue in documentation

- S3 backend is usable and not a Work In Progress anymore. - `auth` command needs a `username` instead of a `user`. - Update link to the latest click documentation.
wilbrdt · Feb 9, 2023 · ccdfc7c · ccdfc7c
1 parent efe73e2
commit ccdfc7c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -24,7 +24,7 @@ The credentials file is expected to be a valid JSON file. Its location is
 specified by the `RALPH_AUTH_FILE` configuration value. By default, `ralph`
 will look for the `auth.json` file in the application directory (see [click
 documentation for
-details](https://click.palletsprojects.com/en/8.0.x/api/#click.get_app_dir)).
+details](https://click.palletsprojects.com/en/8.1.x/api/#click.get_app_dir)).
 
 The expected format is a list of entries (JSON objects) each containing the
 username, the user's `bcrypt` hashed+salted password and scopes they can
@@ -49,7 +49,7 @@ To create a new user credentials, Ralph's CLI provides a dedicated command:
 
 ```bash
 $ ralph auth \
-    --user janedoe \
+    --username janedoe \
     --password supersecret \
     --scope janedoe_scope \
     -w

diff --git a/docs/index.md b/docs/index.md
@@ -18,7 +18,7 @@ backends:
 - [Elasticsearch](https://www.elastic.co/elasticsearch/)
 - [MongoDB](https://www.mongodb.com/)
 - [OpenStack Swift](https://wiki.openstack.org/wiki/Swift)
-- [AWS S3](https://aws.amazon.com/s3/) (_WIP_)
+- [AWS S3](https://aws.amazon.com/s3/)
 - [OVH Logs Data Platform](https://docs.ovh.com/gb/en/logs-data-platform/)\*
 - [WebSocket](https://en.wikipedia.org/wiki/WebSocket)
 - File system