Skip to content

(docs) VM.migrate.md: Rephrase and simplify, improve readability #6307

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

(docs) Update the walk-trough VM.migrate:

  • Include the Live migration flowchart for reference and as overview.
  • Fix the chapter structure and chapter headings: Improved table of contents (1st button in the top bar)
  • Add chapter links to the mentioned atomics operations
  • Covert a long sentence describing a list of parameters into a simple list of parameters
  • Clarify ambiguities, e.g. "if we are already at the right place" -> "if the command is already at the destination host"
  • Removed the use of the word "will" when things are already happening or are done just at that point.
  • Removed sentences that just filled space by just mentioning what the next chapter headline says.
  • Improved the chapter on the final step with more references and a link to a helpful explanation.
  • Updated the links for a better understanding to the currently used URLs.

Copy link
Collaborator Author

@bernhardkaindl bernhardkaindl left a comment

Choose a reason for hiding this comment

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

Here is a preview link to the revamped walk-though for VM_migrate:
https://bernhard-xapi-onrender-com-pr-15.onrender.com/xenopsd/walkthroughs/VM.migrate/

JFYI, as you commented on my workflow on VM.build: cc @stormi (also @gthvn1 and @ydirson)!

This PR just presents everything in an updated way, there is no actual change to the described content, except for more references and headings.

Just to clarify, this is not a new workflow, but with the updates to the chapter headings, conversion of text paragraphs into lists and the cleanups and with including the sequence diagram, it looks like a big update :-)

PS: Here is the preview of the updated table of contents that the ToC button (left in the top bar) shows:

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl force-pushed the docs-VM.migrate-rephrase-and-simplifiy branch from b4a19e9 to 6c33704 Compare February 15, 2025 20:44
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl force-pushed the docs-VM.migrate-rephrase-and-simplifiy branch from 6c33704 to 6d0fef3 Compare February 15, 2025 20:45
Copy link
Contributor

@gthvn1 gthvn1 left a comment

Choose a reason for hiding this comment

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

cool improvements 👍

@psafont psafont added this pull request to the merge queue Feb 17, 2025
Merged via the queue into xapi-project:master with commit e8a34e9 Feb 17, 2025
15 checks passed
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