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

Administration guide: remove content for unavailable features on instances with devworkspace, in the master branch #21270

Closed
25 tasks
themr0c opened this issue Mar 16, 2022 · 1 comment
Closed
25 tasks

Administration guide: remove content for unavailable features on instances with devworkspace, in the master branch #21270

themr0c opened this issue Mar 16, 2022 · 1 comment
Labels
area/doc Issues related to documentation engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. status/doc-impact This issue has an impact on documentation, it is required to provide a documentation update.

Comments

@themr0c
Copy link
Contributor

themr0c commented Mar 16, 2022 •
edited by l0rd
Loading

Is your task related to a problem? Please describe

Administration guide to document only instances with devworkspace.

Describe the solution you'd like

Administration guide: remove content for unavailable features on instances with devworkspace, in the master branch.

Here is the current list of the admin guide articles.
In bold the ones to remove: those that to eventually resume have the [TEMP] suffix, the rest has [DEFINITIVE] suffix.

  • architecutre-overview
    • architecture-overview (with-che-server) [DEFINITIVE]
    • architecture-overview (with-devworkspace)
  • calculating-che-resource-requirements
  • customizing the registries [TEMP]
  • retrieving-che-logs
  • configuring-server-logging
  • viewing-kubernetes-events [DEFINITIVE]
  • viewing-operator-events [TEMP]
  • viewing-che-server-logs [TEMP]
  • viewing-external-service-logs [TEMP]
  • viewing-plug-in-broker-logs [TEMP]
  • collecting-logs-using-chectl
  • monitoring-che
  • monitoring-the-dev-workspace-operator
  • tracing-che [TEMP]
  • backup and recovery [TEMP]
  • migration postgres [TEMP]
  • readiness-init-containers [DEFINITIVE]
  • caching-images-for-faster-workspace-start
  • managing-identities-and-authorizations
    • authenticating-users [TEMP]
    • authorizing-users [TEMP]
    • configuring-authorization [TEMP]
    • removing-user-data

Describe alternatives you've considered

Start from scratch in the main branch.
@themr0c themr0c added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Mar 16, 2022
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Mar 16, 2022
This was referenced Mar 16, 2022
Closed
Merged
@themr0c themr0c changed the title Minimal administration guide for the che-docs main branch Administration guide: remove content for unavailable features on instances with devworkspace Mar 17, 2022
@themr0c themr0c changed the title Administration guide: remove content for unavailable features on instances with devworkspace Administration guide: remove content for unavailable features on instances with devworkspace, in the master branch Mar 17, 2022
@nickboldt nickboldt added severity/P1 Has a major impact to usage or development of the system. area/doc Issues related to documentation engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. status/doc-impact This issue has an impact on documentation, it is required to provide a documentation update. team/doc and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Mar 17, 2022
@pmkovar
Copy link

pmkovar commented Mar 21, 2022

Cloned in Jira: https://issues.redhat.com/browse/RHDEVDOCS-3880

@themr0c themr0c closed this as completed Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/doc Issues related to documentation engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. status/doc-impact This issue has an impact on documentation, it is required to provide a documentation update.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@nickboldt @themr0c @pmkovar @che-bot