Create BYON User Documentation

open-services-group / byon

Bring Your Own Notebook (BYON) project repository.

GNU General Public License v3.0

4 stars 8 forks source link

Create BYON User Documentation #38

Closed oindrillac closed 1 year ago

oindrillac commented 2 years ago

We want to create user documentation that highlights what user should expect and also provides them recommendations on best practices.

Acceptance Criteria:

[ ] Add documentation on good practices/recommendations for creating custom images.
[ ] Add documentation for minimal requirements for image that BYON expects

oindrillac commented 2 years ago

cc: @guimou

oindrillac commented 2 years ago

@tumido @guimou started this document here. Feel free to add your sections here to this doc 🙂

sesheta commented 2 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

sesheta commented 2 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

goern commented 2 years ago

/kind feaure /priority backlog

sesheta commented 2 years ago

@goern: The label(s) kind/feaure cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/open-services-group/byon/issues/38#issuecomment-1246402031): >/kind feaure >/priority backlog 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.

sesheta commented 1 year ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

/close

sesheta commented 1 year ago

@sesheta: Closing this issue.

In response to [this](https://github.com/open-services-group/byon/issues/38#issuecomment-1278862315): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >/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.