Skip to content

Hugo docs: Add dedicated walk-throughs for VM.build and xenguest #6296

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.

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

Conversation

bernhardkaindl
Copy link
Collaborator

@bernhardkaindl bernhardkaindl commented Feb 12, 2025

Add walk-throughs for VM_build (split into 3 pages for improved focus):

The existing walk-though for VM_build as been uses as the basis and extended: The parts which are currently in Chapter 3 of the VM.start workflow have been extracted, moved to new files and extended.

A special improvement is that the deep nesting of lists is split into separate chapters and flattened, which fixes the deep nesting that I initially used.

The new extracted and improved walk-though contains flowcharts that show the execution flow and a call graph to visualise the content of the walk-through.

This PR has 3 commits, the 2nd commit is the big commit.
The 1st and 3rd commit are very small and only minor improvements:

  1. doc/hugo.toml: Use the theme font for mermaid diagrams too
    This is only a cosmetic change to align the font of the Mermaid diagrams
    with the font of the Hugo Relearn theme. It makes the look of the Mermaid
    diagrams more consistent with the more modern theme of the site.
    It is only a very minimal step and very small.
  2. docs: Add dedicated walk-throughs for VM.build and xenguest
    Add walk-throughs for VM_build (split into 3 pages for improved focus).
  3. xenopsd docs: Add Walk-through descriptions, show them on the index page
    Show a short on-line summary of the workflows on the index walk-throug index page

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl
Copy link
Collaborator Author

bernhardkaindl commented Feb 12, 2025

You can preview the new pages of the PR (with the font and the Walk-through descriptions) here:
https://bernhard-xapi-onrender-com-pr-10.onrender.com/xenopsd/walkthroughs/index.html

This is an extract of the index from this link which shows the new pages:

  • Starting a VM
    Complete walkthrough of starting a VM, from receiving the request to unpause.
  • Building a VM
    After VM_create, VM_build builds the core of the domain (vCPUs, memory)
    • VM_build μ-op
      Overview of the VM_build μ-op (runs after the VM_create μ-op created the domain).
    • Domain.build
      Prepare the build of a VM: Wait for scrubbing, do NUMA placement, run xenguest.
    • xenguest
      Perform building VMs: Allocate and populate the domain's system memory.

@lindig
Copy link
Contributor

lindig commented Feb 12, 2025

This is great.

Copy link
Member

@psafont psafont left a comment

Choose a reason for hiding this comment

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

I really like the change!

Maybe mentioning all the chain of functions is not needed and will easily become out-of-date, but this is very positive nonetheless

@psafont psafont added this pull request to the merge queue Feb 12, 2025
Merged via the queue into xapi-project:master with commit 8355506 Feb 12, 2025
15 checks passed
@stormi
Copy link
Contributor

stormi commented Feb 12, 2025

This will make for a good read.

CC @gthvn1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants