docs: add storage options documentation#19
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation site to replace “Object Storage” with a broader “File Storage” concept (S3-compatible buckets plus PVC-backed volumes), and refreshes related references across Platform, Labs, MLOps, and Admin docs.
Changes:
- Replaces the former Object Storage page with a new File Storage page, and updates navigation accordingly.
- Expands Platform Databases documentation with clearer service overview, connection guidance, security/performance notes, and troubleshooting.
- Updates cross-links and terminology across related docs (Workspaces, Kubernetes Resources, Labs, Pipelines, MLflow, Model Serving, Admin runbooks).
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/platform/workspaces.md | Updates workspace-scoped resource wording to “file storage”. |
| docs/platform/object_storage.md | Removes legacy Object Storage page. |
| docs/platform/kubernetes.md | Updates related links to point at File Storage. |
| docs/platform/index.md | Replaces Object Storage entry with File Storage in the Platform overview table. |
| docs/platform/file_storage.md | Adds new File Storage documentation (S3-backed + PVC-backed guidance, security, troubleshooting, FAQ). |
| docs/platform/databases.md | Expands database guidance (services table, connection guidance, security/perf notes, troubleshooting). |
| docs/mlops/pipelines.md | Updates artifact/storage terminology and links to File Storage. |
| docs/mlops/model_serving.md | Updates serving storage wording/links to File Storage. |
| docs/mlops/mlflow.md | Updates MLflow artifact storage wording/links to File Storage. |
| docs/mlops/index.md | Updates Model Serving description to reference S3-compatible file storage. |
| docs/mlops/hyperparameter_tuning.md | Updates persistence guidance and links to File Storage. |
| docs/labs/vscode.md | Updates storage terminology and anchor links to File Storage section. |
| docs/labs/rstudio.md | Updates storage terminology to “file storage”. |
| docs/labs/opencode.md | Updates storage terminology and links to File Storage. |
| docs/labs/jupyterlab.md | Renames Object Storage section to File Storage and updates terminology/links. |
| docs/labs/index.md | Renames Object Storage section to File Storage and updates related guidance/links. |
| docs/labs/custom_notebooks.md | Updates storage terminology to “file storage”. |
| docs/index.md | Updates a home-page task card to link to File Storage. |
| docs/admin/user_management.md | Updates storage terminology to “file storage”. |
| docs/admin/upgrading.md | Updates upgrade checklist terminology to “file storage”. |
| docs/admin/storage.md | Updates storage admin guidance and related links to File Storage. |
| docs/admin/operations_runbooks.md | Updates MinIO operations runbook references to File Storage. |
| docs/admin/installation.md | Updates installation guidance terminology from object storage to file storage. |
| docs/admin/index.md | Updates admin overview wording to “file storage”. |
| docs/admin/backup_restore.md | Updates backup/restore wording and validation checklist to “file storage”. |
| docs/.vitepress/theme/style.css | Adds styling for custom footnote markers used in the new docs. |
| docs/.vitepress/config.mts | Updates top nav from Object Storage to File Storage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Addressed the storage example link findings by using the unpinned |
|
Addressed the latest Copilot findings in commit |
|
Restored the |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 27 out of 30 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
docs/platform/file_storage.md:15
- The page mostly replaces “Object Storage” with “File Storage”, but this sentence reintroduces “object storage” terminology. That’s likely to confuse readers now that the Object Storage page is removed/renamed.
Open **File Storage** in the prokube UI to inspect and manage the buckets available to your workspace. **The File Storage browser uses S3-compatible object storage in the background.** It uses your platform session and shows only storage you are allowed to access.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 27 out of 30 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
docs/platform/file_storage.md:15
- This line reintroduces the “object storage” term after the docs otherwise rename the feature to “File Storage”. To keep terminology consistent (and avoid implying a separate feature), consider describing the backend as “S3-compatible storage/API” instead of “object storage”.
Open **File Storage** in the prokube UI to inspect and manage the buckets available to your workspace. **The File Storage browser uses S3-compatible object storage in the background.** It uses your platform session and shows only storage you are allowed to access.
Summary
Verification