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: add guide about virt-v2v #12184

Merged

Conversation

mihalicyn
Copy link
Member

@mihalicyn mihalicyn commented Aug 28, 2023

Add a small example of using virt-v2v to convert Windows VMs to LXD.

Closes #12154

@github-actions github-actions bot added the Documentation Documentation needs updating label Aug 28, 2023
@mihalicyn mihalicyn force-pushed the doc-import-windows-vm-virt-v2v-guide branch from 493a3da to 04be64b Compare August 28, 2023 16:40
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

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

Thanks!

@mihalicyn
Copy link
Member Author

Hm, it's interesting:

Run make doc-lint
doc/.sphinx/.markdownlint/doc-lint.sh
Failed!
.tmp/doc/howto/import_machines_to_instances.md:46: MD034 Bare URL used
.tmp/doc/howto/import_machines_to_instances.md:47: MD034 Bare URL used
.tmp/doc/howto/import_machines_to_instances.md:110: MD034 Bare URL used
.tmp/doc/howto/import_machines_to_instances.md:214: MD034 Bare URL used

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
make: *** [Makefile:150: doc-lint] Error 1

I haven't used Bare URLs instead [description](link) syntax was used.
And lines 110 and 214 are not from this PR.

@tomponline
Copy link
Member

@ru-fu is our expert on doc linting 😀

Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

For the linting errors:

The last two were there before but had exceptions defined in https://github.com/canonical/lxd/blob/main/doc/.sphinx/.markdownlint/exceptions.txt
The line numbers changed now, so they need to be updated.

I'm not sure about the first two - there isn't really a reason. The first one might be because virtio-win.iso could be mistaken as a URL. If that's the case, putting it in quotes (which we need anyway since it's not a word) should fix it. The second is strange - but let's fix the others first, maybe it'll resolve itself by the other changes. ;)

doc/howto/import_machines_to_instances.md Outdated Show resolved Hide resolved
@mihalicyn mihalicyn force-pushed the doc-import-windows-vm-virt-v2v-guide branch from 04be64b to 883c10b Compare August 29, 2023 13:06
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Looks like it works in the output (except for the backticks in the summary, see comment).

And the strange linting errors disappeared as well! 🎉
For the two that are left, please update the line numbers in https://github.com/canonical/lxd/blob/main/doc/.sphinx/.markdownlint/exceptions.txt

doc/howto/import_machines_to_instances.md Outdated Show resolved Hide resolved
@mihalicyn mihalicyn force-pushed the doc-import-windows-vm-virt-v2v-guide branch 2 times, most recently from 8e78f23 to d61e24f Compare August 30, 2023 16:50
Add a small example of using virt-v2v to convert Windows VMs to LXD.

canonical#12154

Signed-off-by: Alexander Mikhalitsyn <aleksandr.mikhalitsyn@canonical.com>
@mihalicyn mihalicyn force-pushed the doc-import-windows-vm-virt-v2v-guide branch from d61e24f to 05e1d76 Compare August 31, 2023 11:40
@mihalicyn
Copy link
Member Author

Now documentation tests/checks are happy!

@tomponline
Copy link
Member

Thanks both!

@tomponline tomponline merged commit fe8ded4 into canonical:main Aug 31, 2023
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Windows Images Fail to Boot
3 participants