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.

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

Doc: Explain what 'Block migration' does #8222

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thomas-dkmt
Copy link
Contributor

Some users weren't sure what a 'block migration' was. This PR updates the Xen Orchestra documentation to explain that 'Block migration' is an imperative phrase and that enabling this option will prevent the VM from migrating to another host.

Hopefully this will prevent any further confusion till we update the actual button label.

Description

Short explanation of this PR (feel free to re-use commit message)

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

Some users weren't sure what a 'block migration' was.
This commit explains in the XO documentatiojn that 'block migration'
isn't meant as a noun phrase but rather an instruction, as in 'prevent migrations'.
Hopefully this will prevent any confusion till we update the actual button label

Signed-off-by: Thomas Moraine <[email protected]>
@olivierlambert
Copy link
Member

IHMO we need to do both:

  1. document the usage (as you did)
  2. change the wording right in XO UI

Let's wait for the 2. being done and then we'll merge this accordingly.

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.

2 participants