Fix various documentation issues #171

New Issue

oysteikt · 2025-12-13T17:16:09+01:00

oysteikt commented

2025-12-13 17:16:09 +01:00

Make sure the credential instructions doesn't sound like it's suggesting you add the password in plaintext to the config file

Fix this line:

Now you should add the login credentials to the muscl configuration file, typically located at /etc/muscl/config.toml.

Move the password in the credential setup script into an environment variable

Makes it easier to copypaste, also maybe easier to avoid the credential ending up in the shell logs

Edit the order and wording of the edit-privs --help output

Interactive mode: If nothing else is specified, the user will be prompted to edit the privileges using a text editor.

What that "else" means has not been mentioned yet. Consider moving the large text block beneath the usage line if possible (see https://docs.rs/clap/latest/clap/struct.Command.html#method.help_template)

Use "PVV apt repository" instead of "muscl apt repository" in installation instructions, since it's using the global Projects repository to store the package.

Thanks to @felixalb for these finds.

- [ ] Make sure the credential instructions doesn't sound like it's suggesting you add the password in plaintext to the config file Fix this line: > Now you should add the login credentials to the muscl configuration file, typically located at /etc/muscl/config.toml. - [x] Move the password in the credential setup script into an environment variable Makes it easier to copypaste, also maybe easier to avoid the credential ending up in the shell logs - [ ] Edit the order and wording of the `edit-privs --help` output > Interactive mode: If nothing else is specified, the user will be prompted to edit the privileges using a text editor. What that "else" means has not been mentioned yet. Consider moving the large text block beneath the usage line if possible (see https://docs.rs/clap/latest/clap/struct.Command.html#method.help_template) - [x] Use "PVV apt repository" instead of "muscl apt repository" in installation instructions, since it's using the global `Projects` repository to store the package. Thanks to @felixalb for these finds.

oysteikt added this to the Initial release milestone 2025-12-13 17:16:09 +01:00

oysteikt added the documentation label 2025-12-13 17:16:09 +01:00

Sign in to join this conversation.

No Assignees

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Projects/muscl#171