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 DevWorkpace Operator specific features #577

Closed
sleshchenko opened this issue Sep 7, 2021 · 1 comment
Closed

Documentation for DevWorkpace Operator specific features #577

sleshchenko opened this issue Sep 7, 2021 · 1 comment
Assignees
Labels
sprint/current Is assigned to issues which are planned to work on in the current team sprint
Milestone

Comments

@sleshchenko
Copy link
Member

sleshchenko commented Sep 7, 2021

DevWorkspace provides a few features on the top of devfile:

  • mounting secrets/config maps into devworkspace;
  • configuring image pull secrets;
  • configuring git https tokens;
  • configuring devworkspace on namespace level;
  • annotate the devworkspace to debug startup;

Features list is growing on the way we're moving forward integration with Che, and the only place where these features are described - go code.
It's needed to start DevWorkspace Operator Documentation to describe such features, which will be the source of truth for Che and other dependent projects.

From docs team:

a documentation built using Antora and following modular docs guidelines, like what we have for devfile or che-docs would be perfect and much appreciated in the eventuality of a future downstream reuse.
that a new docs project would be best to start using the toolchain we already have in place for Che and devfile docs

@JPinkney
Copy link
Contributor

Initial devworkspace configuration documentation branch is: https://github.com/devfile/devworkspace-operator-docs/tree/configuration-documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sprint/current Is assigned to issues which are planned to work on in the current team sprint
Projects
None yet
Development

No branches or pull requests

3 participants