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

VM Description in backup report #8253

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

truongtx8
Copy link

Description

Sometime, the name does not provide enough information about the VM, adding more with Description, we will know more which VM has issue with backup.

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.

Add VM Description in report
Add VM Description in report
@truongtx8 truongtx8 marked this pull request as draft January 16, 2025 13:42
Add VM Description
@truongtx8 truongtx8 marked this pull request as ready for review January 16, 2025 13:46
@fbeauchamp fbeauchamp requested a review from b-Nollet January 28, 2025 09:36
Copy link
Contributor

@b-Nollet b-Nollet left a comment

Choose a reason for hiding this comment

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

First of all, thank you for your contribution.
I added a few suggestions to improve what you've done:

  • I framed the description of the VM with a {{#if}}{{/if}} to display it only when the VM has a description
  • I slightly changed the description display to make it more consistent with the rest of the backup report
  • I've modified the changelog message to bring it into line with our habits

There are still two changes that the github interface doesn't allow me to suggest:

  • a line - xo-server-backup-reports minor should be added to the ‘Packages to release’ section of the changelog (just after - @xen-orchestra/web-core minor)
  • the description should be moved from line 9 to line 4 in the markdown template.

If you make these changes, then we can merge your PR as soon as possible.

@@ -13,6 +13,7 @@
- [Console]: Displays a loader when the console is loading (PR [#8226](https://github.com/vatesfr/xen-orchestra/pull/8226))

> Users must be able to say: “Nice enhancement, I'm eager to test it”
Add VM Description to the backup report.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Add VM Description to the backup report.
- [Plugin/backup-reports] Add VM Description to the backup report. (contribution made by [@truongtx8](https://github.com/truongtx8)) (PR [#8253](https://github.com/vatesfr/xen-orchestra/pull/8253))

Comment on lines 3 to +4
<ul>
<li><span style="font-weight: bold">Description</span>: {{vm.name_description}}</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<ul>
<li><span style="font-weight: bold">Description</span>: {{vm.name_description}}</li>
{{#if vm.name_description}}
{{vm.name_description}}
{{/if}}
<ul>

@@ -6,6 +6,7 @@
{{else}}
### VM not found

- **Description**: {{{vm.name_description}}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **Description**: {{{vm.name_description}}}
{{#if vm.name_description}}
{{{vm.name_description}}}
{{/if}}

This line should also be moved on line 4 (currently it is in the "VM not found" case)

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