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

Update the VMO index page and document its architecture #3073

Merged
merged 7 commits into from
Jun 18, 2024
Merged

Update the VMO index page and document its architecture #3073

merged 7 commits into from
Jun 18, 2024

Conversation

yuliiiah
Copy link
Contributor

@yuliiiah yuliiiah commented Jun 13, 2024 •
edited by jira bot
Loading

Describe the Change

This PR updates the VMO index page and documents the VMO architecture.

Changed Pages

💻 Virtual Machine Orchestrator
💻 Architecture

Jira Tickets

🎫 DOC-1210

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.— This PR will be merged into the VMO refactor PR, which will then be backported as a single unit.

@yuliiiah yuliiiah changed the title Update the VMO index page Update the VMO index page and document its architecture Jun 13, 2024
@yuliiiah yuliiiah marked this pull request as ready for review June 18, 2024 14:38
@yuliiiah yuliiiah requested a review from a team as a code owner June 18, 2024 14:38
@yuliiiah yuliiiah requested review from karl-cardenas-coding, lennessyy and caroldelwing and removed request for a team June 18, 2024 14:38
github-actions[bot]
github-actions bot reviewed Jun 18, 2024
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/vm-management/architecture.md|184 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/architecture.md|187 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/architecture.md|188 col 90| [Vale.Avoid] Avoid using 'datacenter'.
docs/docs-content/vm-management/architecture.md|188 col 90| [Vale.Spelling] Did you really mean 'datacenter'?
docs/docs-content/vm-management/architecture.md|189 col 41| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/architecture.md|203 col 14| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/architecture.md|215 col 111| [Vale.Spelling] Did you really mean 'Switchport'?
docs/docs-content/vm-management/architecture.md|220 col 24| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/architecture.md|221 col 10| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/architecture.md|221 col 38| [spectrocloud.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/architecture.md|221 col 64| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/architecture.md|223 col 16| [spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/architecture.md|223 col 55| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/architecture.md|233 col 42| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/architecture.md|234 col 26| [spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/architecture.md|251 col 1| [spectrocloud.acronym] Use title case to define the acronym '(RWX)'.
docs/docs-content/vm-management/architecture.md|262 col 3| [Vale.Spelling] Did you really mean 'Netapp'?
docs/docs-content/vm-management/architecture.md|270 col 67| [Vale.Spelling] Did you really mean 'LUNs'?
docs/docs-content/vm-management/architecture.md|277 col 2| [Vale.Terms] Use 'repave' instead of 'Repave'.
docs/docs-content/vm-management/architecture.md|294 col 3| [Vale.Spelling] Did you really mean 'Portworks'?
docs/docs-content/vm-management/architecture.md|297 col 46| [spectrocloud.acronym] Use title case to define the acronym '(RWX)'.
docs/docs-content/vm-management/architecture.md|303 col 32| [Vale.Spelling] Did you really mean 'deduplication'?
docs/docs-content/vm-management/architecture.md|305 col 39| [Vale.Spelling] Did you really mean 'LUNs'?

docs/docs-content/vm-management/vm-management.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
github-actions[bot]
github-actions bot reviewed Jun 18, 2024
View reviewed changes
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
docs/docs-content/vm-management/architecture.md Show resolved Hide resolved
@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 78.6%, saving 216.54 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/vm-mangement_architecture_arch-diagram.webp 36.98 KB 35.72 KB -3.4% View diff
static/assets/docs/images/vm-mangement_vmo-diagram.webp 238.57 KB 23.29 KB -90.2% View diff

698 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 2%, saving 1.17 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/vm-mangement_architecture_arch-diagram.webp 35.72 KB 35.35 KB -1.0% View diff
static/assets/docs/images/vm-mangement_vmo-diagram.webp 23.29 KB 22.49 KB -3.4% View diff

698 images did not require optimisation.

@yuliiiah yuliiiah merged commit 1cc5c2c into vmo-refactor Jun 18, 2024
12 checks passed
@yuliiiah yuliiiah deleted the doc-1210 branch June 18, 2024 15:22
lennessyy added a commit that referenced this pull request Jul 23, 2024
@lennessyy @yuliiiah
@vault-token-factory-spectrocloud @karl-cardenas-coding
docs: VMO refactor (#3040)
87be13f 
* docs: organize vmo structure

* docs: fix broken links

* fix redirect issue

* docs: fix broken link

* docs: fix broken link

* docs: fix broken link

* docs: start refactoring VMO pages

* docs: refactor create and manage VMs

* Update the VMO index page and document its architecture (#3073)

* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>

* docs: progress on vmo

* docs: document options in update configurations

* docs: edit prerequisites

* docs: Update the VMO architecture, add the environment setup topic, other refactoring work

* Optimised images with calibre/image-actions

* docs: fix broken link

* Optimised images with calibre/image-actions

* docs: inclusive language

* docs: fix ablism terms

* docs: address review comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: clarify cpu specifications

* docs: webp conversion

* docs: minor edit

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken admonition

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <horbenko.yuliya@gmail.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 23, 2024
@lennessyy
docs: VMO refactor (#3040)
ff4d274 
* docs: organize vmo structure

* docs: fix broken links

* fix redirect issue

* docs: fix broken link

* docs: fix broken link

* docs: fix broken link

* docs: start refactoring VMO pages

* docs: refactor create and manage VMs

* Update the VMO index page and document its architecture (#3073)

* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>

* docs: progress on vmo

* docs: document options in update configurations

* docs: edit prerequisites

* docs: Update the VMO architecture, add the environment setup topic, other refactoring work

* Optimised images with calibre/image-actions

* docs: fix broken link

* Optimised images with calibre/image-actions

* docs: inclusive language

* docs: fix ablism terms

* docs: address review comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: clarify cpu specifications

* docs: webp conversion

* docs: minor edit

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken admonition

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <horbenko.yuliya@gmail.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
(cherry picked from commit 87be13f)
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 23, 2024
@vault-token-factory-spectrocloud @lennessyy
docs: VMO refactor (#3040) (#3453)
93177e8 
* docs: organize vmo structure

* docs: fix broken links

* fix redirect issue

* docs: fix broken link

* docs: fix broken link

* docs: fix broken link

* docs: start refactoring VMO pages

* docs: refactor create and manage VMs

* Update the VMO index page and document its architecture (#3073)

* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>

* docs: progress on vmo

* docs: document options in update configurations

* docs: edit prerequisites

* docs: Update the VMO architecture, add the environment setup topic, other refactoring work

* Optimised images with calibre/image-actions

* docs: fix broken link

* Optimised images with calibre/image-actions

* docs: inclusive language

* docs: fix ablism terms

* docs: address review comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: clarify cpu specifications

* docs: webp conversion

* docs: minor edit

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken admonition

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <horbenko.yuliya@gmail.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
(cherry picked from commit 87be13f)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions GitHub Actions github-actions left review comments

@karl-cardenas-coding karl-cardenas-coding Awaiting requested review from karl-cardenas-coding karl-cardenas-coding was automatically assigned from spectrocloud/docs-education

@lennessyy lennessyy Awaiting requested review from lennessyy lennessyy was automatically assigned from spectrocloud/docs-education

@caroldelwing caroldelwing Awaiting requested review from caroldelwing caroldelwing was automatically assigned from spectrocloud/docs-education

Assignees
No one assigned
Labels
refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@yuliiiah