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

Identify and deliver minimal administration guide, installation guide, and user guide to migrate to che-docs master branch #21264

Closed
themr0c opened this issue Mar 15, 2022 · 4 comments
Closed

Identify and deliver minimal administration guide, installation guide, and user guide to migrate to che-docs master branch #21264

themr0c opened this issue Mar 15, 2022 · 4 comments
Assignees
@themr0c
Labels
area/doc Issues related to documentation 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.

Comments

@themr0c
Copy link
Contributor

themr0c commented Mar 15, 2022 •
edited by ibuziuk
Loading

Is your task related to a problem? Please describe

In the che-docs master branch, we started a fresh documentation for Che using the Devworkspace engine only.

Describe the solution you'd like

We need to migrate docs from the che-docs master branch that are still relevant.

Describe alternatives you've considered

Blog posts are not covering everything eclipse-che/blog#19

Additional context

STEP 1: Remove obsolete sections considered

STEP 2: Update remaining content

STEP 3: Add new content (not required for v3.0, described in a separate issue)
@themr0c themr0c added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Mar 15, 2022
@themr0c themr0c mentioned this issue Mar 15, 2022
Closed
35 tasks
@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 15, 2022
@themr0c themr0c added area/doc Issues related to documentation team/doc labels Mar 15, 2022
@themr0c themr0c changed the title minimal admin guide, install guide, and end user guides for 3.0 minimal admin guide, install guide, and end user guides to migrate to che-docs main branch Mar 15, 2022
@nickboldt
Copy link
Contributor

nickboldt commented Mar 15, 2022 •
edited
Loading

customizing registries ... that section is SOOO outdated/broken - see https://issues.redhat.com/browse/CRW-2459 for work in downstream (which is on hold as we try to get ready for 3.0)

backup-restore can be ripped out, that's not supported w/ DW

minikube stuff not relevant to downstream

differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode didn't we drop support for one of those modes? @l0rd ?

authoring-devfiles-version-1 - likely remove this as we don't want to encourage use of deprecated standards

why is this a "no"? [NO] installing-che-on-openshift-4-using-operatorhub -- that's 100% supported and recommended, as is the cli method

kubespray, gcp, and azure? I don't think those are supported. AWS is only supported in the context of ROSA afaik @RickJWagner ?

I'd remove the whole "running-che-locally" section as that's prone to problems. maybe keep codeready containers if @l0rd agrees ?

setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page NO - sso/keycloak is not supported in DevSpaces 3 / anything with DW

enabling-dev-workspace-operator isn't needed as it's on by default

upgrading-che-namespace-strategies-other-than-per-user I suspect this is no longer supported - please check with @l0rd or @ibuziuk or @dmytro-ndp

rolling-back-a-che-upgrade not sure if this is possible with DW, as backup-restore is not supported

@themr0c themr0c changed the title minimal admin guide, install guide, and end user guides to migrate to che-docs main branch Minimal admin guide, install guide, and end user guides to migrate to che-docs main branch Mar 15, 2022
@themr0c themr0c changed the title Minimal admin guide, install guide, and end user guides to migrate to che-docs main branch Minimal admin guide, install guide, and user guides to migrate to che-docs main branch Mar 15, 2022
@themr0c themr0c changed the title Minimal admin guide, install guide, and user guides to migrate to che-docs main branch Identify and deliver minimal administration guide, installation guide, and user guide to migrate to che-docs main branch Mar 15, 2022
@sparkoo sparkoo added severity/P1 Has a major impact to usage or development of the system. severity/P2 Has a minor but important impact to the usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. severity/P1 Has a major impact to usage or development of the system. labels Mar 15, 2022
@RickJWagner
Copy link
Contributor

Re: AWS support: Yes, we support on AWS (outside of ROSA).
We also test/develop/replicate in this environment (via cluster-bot).

@nickboldt nickboldt mentioned this issue Mar 16, 2022
Closed
@nickboldt
Copy link
Contributor

To help map the blog posts to the future Guides, I've added a Guides column to the list of blogs. eclipse-che/blog#19 (comment) It is subject to interpretation / edit by various owners/stakeholders. WDYT @themr0c @l0rd ?

@l0rd
Copy link
Contributor

l0rd commented Mar 21, 2022

Created a new issue for contributing and extensions #21286. Cleaned up the description.

@ibuziuk ibuziuk mentioned this issue Mar 23, 2022
Merged
6 tasks
@l0rd l0rd mentioned this issue Mar 24, 2022
Closed
@ibuziuk ibuziuk assigned amisevsk and unassigned amisevsk Mar 24, 2022
This was referenced Mar 24, 2022
Merged
Merged
@ibuziuk ibuziuk mentioned this issue Apr 5, 2022
Closed
45 tasks
@ibuziuk ibuziuk changed the title Identify and deliver minimal administration guide, installation guide, and user guide to migrate to che-docs main branch Identify and deliver minimal administration guide, installation guide, and user guide to migrate to che-docs master branch Apr 6, 2022
@ibuziuk ibuziuk mentioned this issue Apr 25, 2022
Closed
58 tasks
@l0rd l0rd mentioned this issue Apr 28, 2022
Closed
5 tasks
@ibuziuk ibuziuk removed the severity/P2 Has a minor but important impact to the usage or development of the system. label May 12, 2022
@ibuziuk ibuziuk added the severity/P1 Has a major impact to usage or development of the system. label May 12, 2022
@themr0c themr0c closed this as completed May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@themr0c themr0c

Labels
area/doc Issues related to documentation 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.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@nickboldt @themr0c @RickJWagner @l0rd @sparkoo @ibuziuk @amisevsk @che-bot