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

Documentation for ocm download cli missing substantial things #318

Open
morri-son opened this issue Nov 7, 2024 · 0 comments
Open

Documentation for ocm download cli missing substantial things #318

morri-son opened this issue Nov 7, 2024 · 0 comments
Labels
area/documentation Documentation related area/ipcei Important Project of Common European Interest kind/bugfix Bug kind/task small task, normally part of feature or epic

Comments

@morri-son
Copy link
Contributor

morri-son commented Nov 7, 2024

What happened:
Like described in open-component-model/ocm#1029 the ocm download clidoes not work like expected. Besides the fact that it technically does not work, the documentation for that command seems to be buggy and needs to be improved. An end user has to understand what he may miss in the command and its options when getting an unexpected result. There should be examples of the basic scenarios and also an explanation of the result a download has, which is a complex folder structure, here assuming the option -O /tmp for the target folder has been specified:

/tmp/ocm
└── ocm.software
    └── ocmcli
        ├── 0.1.0-alpha.2
        ├── 0.1.0-dev
        ├── 0.10.0
        ├── 0.11.0
        ├── 0.12.0
        ├── 0.3.0-rc.2
        └── 0.9.0
         ...

What you expected to happen:
The documentation should be more precise and focus on the standard scenario. This scenario should have an example.

@morri-son morri-son added area/documentation Documentation related kind/bugfix Bug kind/task small task, normally part of feature or epic labels Nov 7, 2024
@github-actions github-actions bot added the area/ipcei Important Project of Common European Interest label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related area/ipcei Important Project of Common European Interest kind/bugfix Bug kind/task small task, normally part of feature or epic
Projects
Status: 🆕 ToDo
Development

No branches or pull requests

1 participant