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.

Sign up for GitHub

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

Jump to bottom

Create OCM Library developer documentation #132

Open
Tracked by #161
In-Ko opened this issue Nov 10, 2022 · 3 comments · May be fixed by open-component-model/ocm#367
Open
Tracked by #161

Create OCM Library developer documentation #132

In-Ko opened this issue Nov 10, 2022 · 3 comments · May be fixed by open-component-model/ocm#367
Assignees
@fabianburth
Labels
area/documentation component/ocm-core

Comments

@In-Ko
Copy link
Member

In-Ko commented Nov 10, 2022

Description
The library needs a good developer documentation, explaining how it should be used for the most common usecases. There must be example usages for these usecases, to enable developers using the library in an easy to follow approach. Possibly, this documentation could show how the library is used in the OCM CLI.

This documentation needs to be available also on the ocm.software website, similar to the OCM client documentation.
@In-Ko In-Ko mentioned this issue Nov 10, 2022
Closed
1 task
@In-Ko
Copy link
Member Author

In-Ko commented May 8, 2023

Another open source project (Landscaper: https://github.com/gardener/landscaper), intents to make use of the go libraries. At its current state (complexity and especially missing developer documentation), it seems very hard to do so.

This is why some Landscaper developers already looked into the library and are in preparation for a first iteration of a documentation, outlining the go library structure and also some details of certain packages.

@In-Ko In-Ko linked a pull request May 30, 2023 that will close this issue
ocm-lib introduction open-component-model/ocm#367
Draft
@In-Ko
Copy link
Member Author

In-Ko commented May 30, 2023

The open-component-model/ocm#367 is a start to provide an overview of the ocm library, for developers.

@In-Ko In-Ko mentioned this issue May 30, 2023
Closed
2 tasks
@jensh007 jensh007 mentioned this issue Jun 1, 2023
Closed
@fabianburth
Copy link

fabianburth commented Jun 1, 2023 •
edited

The documentation process in open-component-model/ocm#367 is currently on-hold due to considerable reworks of the ocm-lib that affect the basic concepts explained in the documentation.

Generally, the following tasks will have to be adressed:

  • Rework and improve the deprecated parts of the documentation
  • Incorporate feedback (make explanations even more clear and enrich with examples)

@In-Ko In-Ko changed the title Create OCM Library documentation Create OCM Library developer documentation Jun 26, 2023
@morri-son morri-son transferred this issue from open-component-model/ocm Mar 17, 2024
@robertwol robertwol mentioned this issue Mar 25, 2024
Open
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fabianburth fabianburth

Labels
area/documentation component/ocm-core
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ocm-lib introduction fabianburth/ocm
3 participants
@In-Ko @fabianburth @morri-son