-
Notifications
You must be signed in to change notification settings - Fork 64
Open
Labels
Description
Problem:
Documentation shows outdated CLI syntax that fails in Rucio 38.5.1:
rucio -a=root -S=OIDC -v whoami # Error: No such option: -adocumentation/docs/user/using_the_client.md
Lines 122 to 124 in 4d8b8a1
| ```bash | |
| rucio -a=\<rucio_account_name\> -S=OIDC -v whoami | |
| ``` |
ff.
Logs:
[root@rucio-server-8658d7545c-drzb5 tmp]# rucio --version
Unable to load schema module rucio_it_tools.rucio_it_sme_policy.schema from policy package, falling back to generic
rucio 38.5.1
[root@rucio-server-8658d7545c-drzb5 tmp]# rucio -a=root -S=OIDC -v whoami
Unable to load schema module rucio_it_tools.rucio_it_sme_policy.schema from policy package, falling back to generic
Usage: rucio [OPTIONS] COMMAND [ARGS]...
Try 'rucio -h' for help.
Error: No such option: -a
Question: How do we prevent docs from becoming outdated?
Potential Solutions:
- Automated CLI testing in CI - Run documented commands as part of CI
- Version-specific docs - Separate doc branches per major release
- Breaking change checklist - Require doc updates in PRs that change interfaces
- Executable examples - Use integration tests as living documentation
Immediate Action Needed:
- Fix current CLI examples to match v38.5.1 syntax
- Decide on long-term documentation maintenance strategy
Should we create issues for:
- Fixing the outdated CLI examples?
- Implementing automated doc validation in CI?