Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated documentation and the help #478

Open
kostas-kou opened this issue Dec 2, 2024 · 0 comments · May be fixed by #487
Open

Outdated documentation and the help #478

kostas-kou opened this issue Dec 2, 2024 · 0 comments · May be fixed by #487
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@kostas-kou
Copy link
Contributor

kostas-kou commented Dec 2, 2024

Describe the bug
The repo's documentation is outdated and there are some errors, go through the documentation and make changes.
The help command should follow the docker style of help and add a link of the documentation for the specific version in the help command.

Steps to reproduce

Additional context
There is also an error in the description of the list sub command

./sda-cli -config <configuration_file> list --datasets --url <login_url> (--bytes)

login_url is wrong, should be download_url

Another one is in the download section:

./sda-cli -config download <configuration_file> -dataset-id <datasetID> -url <download-service-url> -outdir <outdir> <path/to/file1> <other/path/to/file2> ... (or <fileID_1> <fileID_2> ...)

the download should be after the <configuration_file>

Estimation of size: small

Estimation of priority: high

@kostas-kou kostas-kou added bug Something isn't working documentation Improvements or additions to documentation labels Dec 2, 2024
@kostas-kou kostas-kou changed the title Outdated documentation Outdated documentation and the help Dec 4, 2024
@nanjiangshu nanjiangshu self-assigned this Jan 9, 2025
@nanjiangshu nanjiangshu linked a pull request Jan 10, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants