document CNBi feature design

open-services-group / scrum

SCRUM issues and user stories

GNU General Public License v3.0

0 stars 2 forks source link

document CNBi feature design #38

Closed codificat closed 2 years ago

codificat commented 2 years ago

As a developer of the CNBi feature for ODH I want to have a document that describes the functionality that is being implemented and how it is designed, so that I have an understanding of the components involved and their interactions and dependencies

Acceptance criteria

[x] A public document exists that explains the Custom Notebook Image (CNBi) functionality
[ ] The documentation includes a description of the components involved
[x] The documentation has diagrams that illustrate the functionality, the components, and their relationships
[ ] The documentation includes pointers to further details / sources

goern commented 2 years ago

/kind documentation /triage needs-information /priority important-soon

codificat commented 2 years ago

There is a new repository to host the CNBi documentation: https://github.com/thoth-station/opendatahub-cnbi

The entry point to the documentation will be the README file in that repository. This document is currently being actively worked on in a collaborative way at https://hackmd.io/@thoth-station/ryWW3dsRc

codificat commented 2 years ago

/triage accepted /assign /lifecycle active

goern commented 2 years ago

see https://hackmd.io/6BgU6fdSRvyMLZNPwGykfg

codificat commented 2 years ago

Need to also document the pipelines, and add pointers to additional refs (e.g. byon, odh dashboard etc)

codificat commented 2 years ago

/wg cnbi

sesheta commented 2 years ago

@codificat: The label(s) wg/cnbi cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/open-services-group/scrum/issues/38#issuecomment-1259236891): >/wg cnbi Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

codificat commented 2 years ago

Superseded by https://github.com/thoth-station/opendatahub-cnbi/issues/22 /close

sesheta commented 2 years ago

@codificat: Closing this issue.

In response to [this](https://github.com/open-services-group/scrum/issues/38#issuecomment-1268876022): >Superseded by https://github.com/thoth-station/opendatahub-cnbi/issues/22 >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.