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

Doumentation missing: ocm install command and plugins in general #1056

Open
jensh007 opened this issue Nov 7, 2024 · 2 comments
Open

Doumentation missing: ocm install command and plugins in general #1056

jensh007 opened this issue Nov 7, 2024 · 2 comments
Labels
area/documentation Documentation related area/ipcei Important Project of Common European Interest kind/bugfix Bug

Comments

@jensh007
Copy link
Contributor

jensh007 commented Nov 7, 2024

What happened:
The cli-reference at https://ocm.software is missing the command ocm install

The documentation on ocm-software should get a section about plugins in general:

  • What is the purpose of plugins?
  • What kind of plugins exist and what extensions points exist (e.g. upload/download handler)?
  • How are they installed and configured?
  • Configuration example for the demo plugin
  • Running the demo plugin
  • Credential handling

What you expected to happen:
Added documentation

How to reproduce it (as minimally and precisely as possible):
n/a

Anything else we need to know:

Environment:
n/a

@jensh007 jensh007 added the kind/bugfix Bug label Nov 7, 2024
@github-actions github-actions bot added the area/ipcei Important Project of Common European Interest label Nov 7, 2024
@morri-son morri-son added the area/documentation Documentation related label Nov 7, 2024
@ikhandamirov
Copy link
Contributor

@morri-son
Copy link
Contributor

Regarding installation: https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_install_plugins.md

@ikhandamirov @Skarlso (as I know you heavily worked on getting the cli reference synced to the website): Can you please check why the install command has not been synced to the webpage?

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
Projects
Status: 🆕 ToDo
Development

No branches or pull requests

3 participants