eclipse-che
Improve documentation section "Preparing the installation"
Is your enhancement related to a problem? Please describe
Current documentation provides some installation guidelines (supported platforms, architecture and resource requirements) but do not provide answers to some important questions such as Dev Spaces limits and load tests results, storage and networking consideration, running Dev Spaces across multiple OpenShift clusters, backup strategy.
Describe the solution you'd like
The proposal is to refactor the Preparing the installation section as follow:
Preparing the installation
├── Supported platforms <== KEEP AS IS
├── Installing the chectl management tool <== MOVE TO "Installing Che using the CLI"
├── Architecture <== UPDATE (review content, update diagrams to use excalidraw, add new subsection)
│ └── Workspace creation flow <== NEW SECTON (what happens when the developer clicks on create workspace)
├── Calculating Dev Space resource requirements <== UPDATE (add subsections)
│ ├── Server components requirements
│ ├── Developer environments requirements
│ │ ├── Running burstable workloads in Kubernetes
│ │ ├── Dev Spaces workspace Pod: diagram and defaults (include routes/ingress and PVC too)
│ │ ├── Consider all the variables (time spent reading code vs using CPU)
│ │ └── Observe and adjust
│ ├── Choosing between a dedicated cluster or a shared cluster
│ ├── A real world example (Red Hat Developer Sandbox)
│ └── Using the Cluster Autoscaler
├── Eclipse Che Limits <== NEW SECTION
│ ├── concurrent users limits
│ ├── load tests results
│ └── running dev spaces across multiple clusters
├── Network considerations <== NEW SECTION
├── Storage considerations <== NEW SECTION
└── Backup strategy <== NEW SECTION
Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.
Mark the issue as fresh with /remove-lifecycle stale in a new comment.
If this issue is safe to close now please do so.
Moderators: Add lifecycle/frozen label to avoid stale mode.
@deerskindoll is this issue actual?
I haven't done this yet. if you want, I can adjust the doc structure. I'm not sure if I have all the information I need to create the new sections, though.