docs: Workspace refactor #5064

lennessyy · 2024-12-13T20:45:19Z

Describe the Change

This PR refactors the workspace section.

Changed Pages

💻 Workspaces

Jira Tickets

🎫 Jira Ticket

Backports

Can this PR be backported?

Yes. Remember to add the relevant backport labels to your PR.
No. Please leave a short comment below about why this PR cannot be backported.

netlify · 2024-12-13T20:45:44Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`8274d02`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/6765e5606944830008999d3c
😎 Deploy Preview	https://deploy-preview-5064--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs-content/workspace/workspace-mgmt/restrict-images.md

github-actions · 2024-12-18T18:42:57Z

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

+| **Resource**           | **Description availed from Workspace**                                                                                                                                       |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Namespaces**         | Cluster Specific namespaces with CPU and Memory utilization.                                                                                                                 |
+| **Pods**               | Lists all the pods running on a particular namespace with cluster names with the detailed health status, age, and resource utilization of each of them.                      |


🚫 [vale] _{reported by reviewdog 🐶}
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

github-actions · 2024-12-18T18:42:57Z

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Namespaces**         | Cluster Specific namespaces with CPU and Memory utilization.                                                                                                                 |
+| **Pods**               | Lists all the pods running on a particular namespace with cluster names with the detailed health status, age, and resource utilization of each of them.                      |
+| **Deployments**        | All the running deployments specific to clusters belonging to the Workspace with namespace to which these deployments belong, pods details, replicas, and age are enumerated |


🚫 [vale] _{reported by reviewdog 🐶}
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'running'.

github-actions · 2024-12-18T18:42:57Z

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

+| **DaemonSets**         | DaemonSet resource utilization is described, with details on namespaces, pods, and age of individual Daemon sets                                                             |
+| **StatefulSets**       | All the active StatefulSets specific to clusters belonging to the Workspace with corresponding namespace, pods details, replicas, and age are enumerated                     |
+| **Jobs**               | A Job creates one or more Pods and will continue to retry execution of the Pods until a specified number of them successfully terminate.                                     |
+| **CronJobs**           | Cron Jobs are regularly scheduled actions or jobs such as backups, report generation, etc. Each of these jobs will recur as scheduled.                                       |


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Cron'?

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

docs/docs-content/workspace/workspace-mgmt/configure-rbac.md

…librarium into workspace-refactor

docs/docs-content/workspace/workspace-mgmt/backup-restore.md

…librarium into workspace-refactor

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

caroldelwing

Approved with a few suggestions

docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md

docs/docs-content/workspace/adding-a-new-workspace.md

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

docs/docs-content/workspace/workspace-mgmt/restrict-images.md

docs/docs-content/workspace/workspace.md

Co-authored-by: caroldelwing <[email protected]>

docs/docs-content/workspace/workspace-mgmt/delete-workspace.md

Co-authored-by: caroldelwing <[email protected]>

github-actions · 2024-12-20T21:42:43Z

docs/docs-content/workspace/workspace-mgmt/resource-mgmt.md

+   the workspace quota when added together.
+
+   For example, if you have two clusters in the workspace and impose a workspace-level quota of 8 Gi of memory and 8
+   CPUs, when each instance of the namespace in each cluster is added together, the total memory and CPU quota cannot


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'CPUs'?

github-actions · 2024-12-20T21:45:54Z

docs/docs-content/workspace/workspace-mgmt/backup-restore.md

+   | ------------------------- | ------------------------------------------------------------------------- |
+   | Include Cluster Resources | Check the box to restore all the cluster scoped resources.                |
+   | Preserve Node Ports       | Check the box to preserve ports for the node port service in the cluster. |
+   | Restore PVs               | Check the box to restore the persistent volumes.                          |


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'PVs'?

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]> (cherry picked from commit 2d142f0)

vault-token-factory-spectrocloud · 2024-12-20T21:57:27Z

💔 Some backports could not be created

Status	Branch	Result
❌	version-4-0	Backport failed because of merge conflicts You might need to backport the following PRs to version-4-0: - docs: updated URLs to use file path context
❌	version-4-1	Backport failed because of merge conflicts
✅	version-4-2
✅	version-4-3
✅	version-4-4
✅	version-4-5

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 5064

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]> (cherry picked from commit 2d142f0) Co-authored-by: Lenny Chen <[email protected]>

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]>

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]> (cherry picked from commit 2d142f0) Co-authored-by: Lenny Chen <[email protected]>

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]>

* docs: start working on the create page * docs: more workspace refactor work * docs: progress on workspace refactor * docs: finish workspace pages * docs: fix broken lilnk * docs: remove feature page * docs: broken link fix * docs: edit workspaces * docs: copy edits * docs: add backup page * docs: add backup & restore sections * docs: adjust page order * docs: add more examples * docs: modify example * docs: add restore options * docs: vale * Apply suggestions from code review * Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: caroldelwing <[email protected]>

lennessyy added 2 commits December 11, 2024 15:01

docs: start working on the create page

b136437

docs: more workspace refactor work

780579b

lennessyy added the do-not-merge/work-in-progress Work in-progress. DO NOT MERGE label Dec 13, 2024

lennessyy and others added 7 commits December 13, 2024 13:51

Merge branch 'master' into workspace-refactor

3c88d50

docs: progress on workspace refactor

eb13bbb

docs: finish workspace pages

c8bb902

docs: fix broken lilnk

5ebbe98

docs: remove feature page

89be8c9

docs: broken link fix

d2c3c63

docs: edit workspaces

f25269e

lennessyy marked this pull request as ready for review December 18, 2024 18:41

lennessyy requested a review from a team as a code owner December 18, 2024 18:41

lennessyy requested review from karl-cardenas-coding, benradstone and caroldelwing December 18, 2024 18:41

Merge branch 'master' into workspace-refactor

1ad21f4

github-actions bot reviewed Dec 18, 2024

View reviewed changes

lennessyy added 4 commits December 18, 2024 14:18

docs: copy edits

b9cc987

Merge branch 'workspace-refactor' of https://github.com/spectrocloud/…

2d861ce

…librarium into workspace-refactor

docs: add backup page

34ac027

docs: add backup & restore sections

e5073f9

github-actions bot reviewed Dec 20, 2024

View reviewed changes

docs/docs-content/workspace/workspace-mgmt/backup-restore.md Outdated Show resolved Hide resolved

lennessyy and others added 5 commits December 19, 2024 17:20

docs: adjust page order

30c6529

Merge branch 'master' into workspace-refactor

5c90191

docs: add more examples

7571e6b

docs: modify example

89f186f

Merge branch 'workspace-refactor' of https://github.com/spectrocloud/…

782a938

…librarium into workspace-refactor

github-actions bot reviewed Dec 20, 2024

View reviewed changes

docs: add restore options

64b2589

Merge branch 'master' into workspace-refactor

e5951b1

caroldelwing approved these changes Dec 20, 2024

View reviewed changes

Apply suggestions from code review

0b9727e

Co-authored-by: caroldelwing <[email protected]>

lennessyy commented Dec 20, 2024

View reviewed changes

docs/docs-content/workspace/workspace-mgmt/delete-workspace.md Outdated Show resolved Hide resolved

lennessyy and others added 3 commits December 20, 2024 13:40

Update docs/docs-content/workspace/workspace-mgmt/delete-workspace.md

2acecc3

Apply suggestions from code review

d37095f

Co-authored-by: caroldelwing <[email protected]>

Apply suggestions from code review

0e60110

Co-authored-by: caroldelwing <[email protected]>

lennessyy enabled auto-merge (squash) December 20, 2024 21:42

github-actions bot reviewed Dec 20, 2024

View reviewed changes

ci: auto-formatting prettier issues

8274d02

github-actions bot reviewed Dec 20, 2024

View reviewed changes

lennessyy merged commit 2d142f0 into master Dec 20, 2024
15 checks passed

lennessyy deleted the workspace-refactor branch December 20, 2024 21:55

vault-token-factory-spectrocloud bot mentioned this pull request Dec 20, 2024

[version-4-2] docs: Workspace refactor (#5064) #5129

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Dec 20, 2024

[version-4-3] docs: Workspace refactor (#5064) #5130

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Dec 20, 2024

[version-4-4] docs: Workspace refactor (#5064) #5131

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Dec 20, 2024

[version-4-5] docs: Workspace refactor (#5064) #5132

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Workspace refactor #5064

docs: Workspace refactor #5064

lennessyy commented Dec 13, 2024 •

edited

Loading

netlify bot commented Dec 13, 2024 •

edited

Loading

github-actions bot Dec 18, 2024

github-actions bot Dec 18, 2024

github-actions bot Dec 18, 2024

caroldelwing left a comment

github-actions bot Dec 20, 2024

github-actions bot Dec 20, 2024

vault-token-factory-spectrocloud bot commented Dec 20, 2024

docs: Workspace refactor #5064

docs: Workspace refactor #5064

Conversation

lennessyy commented Dec 13, 2024 • edited Loading

Describe the Change

Changed Pages

Jira Tickets

Backports

netlify bot commented Dec 13, 2024 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

github-actions bot Dec 18, 2024

Choose a reason for hiding this comment

github-actions bot Dec 18, 2024

Choose a reason for hiding this comment

github-actions bot Dec 18, 2024

Choose a reason for hiding this comment

caroldelwing left a comment

Choose a reason for hiding this comment

github-actions bot Dec 20, 2024

Choose a reason for hiding this comment

github-actions bot Dec 20, 2024

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Dec 20, 2024

💔 Some backports could not be created

Manual backport

Questions ?

lennessyy commented Dec 13, 2024 •

edited

Loading

netlify bot commented Dec 13, 2024 •

edited

Loading