Add LXD and OpenStack image documentation #289

mstpn · 2024-10-23T20:24:16Z

Our public docs were missing explanations for our image offerings on cloud-images.ubuntu.com for LXD and OpenStack.

An "Explanation" index and landing page has been created on the public-images project now that there is more than one Explanation article.

A commit fixing the American spelling of artifact to the British spelling artefact across our docs is included in this PR as well.

Artefact(s) is the British spelling and should be used. `artifacts` was in the `custom_wordlist` and was hiding this.

codyshepherd

A couple of minor things, but otherwise lgtm.

public-images/public-images-explanation/index.rst

public-images/public-images-explanation/lxd-openstack-images.rst

k-dimple

Thanks Matthew, this is really good. My comments are mostly just nits.

public-images/index.rst

public-images/public-images-explanation/lxd-openstack-images.rst

k-dimple · 2024-11-06T09:31:18Z

public-images/public-images-explanation/lxd-openstack-images.rst

+
+   - The bootable disk image for a virtual machine is a :ref:`qcow-ref` image (``*.img``)
+
+The following are example commands to import LXD containers and virtual machines, respectively, based on downloaded Ubuntu 24.04 artefacts:


Suggested change

The following are example commands to import LXD containers and virtual machines, respectively, based on downloaded Ubuntu 24.04 artefacts:

The following are example commands to import an image into LXD containers and virtual machines, respectively, based on downloaded Ubuntu 24.04 artefacts:

Does that make sense? Or maybe something like 'to import an image to create LXD containers and virtual machines'?

Good catch here, I think some context got lost when I was reworking the sentence. This makes sense to me: "The following are example commands to import an image for creating LXD containers and virtual machines based on downloaded Ubuntu 24.04 artifacts."

You could have directly included that! :)

I thought I had :) Wrote both down in the editor to compare and must have deleted the new one instead of the old.

public-images/public-images-explanation/lxd-openstack-images.rst

k-dimple · 2024-11-06T09:34:29Z

public-images/public-images-explanation/lxd-openstack-images.rst

+— which exposes the full functionality of the ``guestfs`` API — or
+rely on the ``virt-*`` tools from ``libguestfs`` — like ``virt-cat`` for
+displaying files, ``virt-df`` for checking free space, and
+``virt-inspector`` for inspecting VM images — to perform specific tasks.


Suggested change

``virt-inspector`` for inspecting VM images — to perform specific tasks.

``virt-inspector`` for inspecting VM images.

Looks like you missed this change. Isn't it easier to add all the suggestions that you agree with into a single batch commit from the git UI itself (rather than changing all of them again in your version)?

Whoops, many changes to this sentence and this one slipped.

I usually fix in one commit and then rebase to keep the commit history clean, and haven't looked into doing that via the GitHub UI. And I run the spell/link checks locally as well after changes instead of hoping they pass CI.

Using the Add suggestion to batch in the UI option allows you to create a single commit. But yeah you'll still need to squash commits to keep the commit history clean and run the spell/link checks locally.

mstpn · 2024-11-07T01:13:19Z

Thanks for the detailed review as always @k-dimple.

k-dimple

LGTM. Just add your version of the statement (the one that made sense to you) and remove the last bit that was missed.

Thanks for creating all the links!

k-dimple · 2024-11-07T08:27:47Z

public-images/public-images-explanation/lxd-openstack-images.rst

+— which exposes the full functionality of the ``guestfs`` API — or
+rely on the ``virt-*`` tools from ``libguestfs`` — like ``virt-cat`` for
+displaying files, ``virt-df`` for checking free space, and
+``virt-inspector`` for inspecting VM images — to perform specific tasks.


Looks like you missed this change. Isn't it easier to add all the suggestions that you agree with into a single batch commit from the git UI itself (rather than changing all of them again in your version)?

fix: changed artifact(s) to artefact(s)

6b3c306

Artefact(s) is the British spelling and should be used. `artifacts` was in the `custom_wordlist` and was hiding this.

codyshepherd approved these changes Oct 24, 2024

View reviewed changes

public-images/public-images-explanation/index.rst Outdated Show resolved Hide resolved

public-images/public-images-explanation/lxd-openstack-images.rst Outdated Show resolved Hide resolved

mstpn force-pushed the cpc3365-lxd-and-openstack-images branch from 0d54316 to 6bd4be9 Compare November 4, 2024 20:29

k-dimple requested changes Nov 6, 2024

View reviewed changes

mstpn force-pushed the cpc3365-lxd-and-openstack-images branch from 6bd4be9 to ef547d1 Compare November 7, 2024 01:11

mstpn requested a review from k-dimple November 7, 2024 01:13

k-dimple approved these changes Nov 7, 2024

View reviewed changes

feat(docs): Add public documentation for LXD and OpenStack images

51fe930

mstpn force-pushed the cpc3365-lxd-and-openstack-images branch from ef547d1 to 51fe930 Compare November 8, 2024 02:01

k-dimple merged commit 87d8fdd into canonical:main Nov 8, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add LXD and OpenStack image documentation #289

Add LXD and OpenStack image documentation #289

mstpn commented Oct 23, 2024

codyshepherd left a comment

k-dimple left a comment

k-dimple Nov 6, 2024

mstpn Nov 6, 2024

k-dimple Nov 7, 2024

mstpn Nov 8, 2024

k-dimple Nov 6, 2024

k-dimple Nov 7, 2024 •

edited

Loading

mstpn Nov 8, 2024 •

edited

Loading

k-dimple Nov 8, 2024

mstpn commented Nov 7, 2024

k-dimple left a comment •

edited

Loading

k-dimple Nov 7, 2024 •

edited

Loading


		- The bootable disk image for a virtual machine is a :ref:`qcow-ref` image (``*.img``)

		The following are example commands to import LXD containers and virtual machines, respectively, based on downloaded Ubuntu 24.04 artefacts:

	``virt-inspector`` for inspecting VM images — to perform specific tasks.
	``virt-inspector`` for inspecting VM images.

Add LXD and OpenStack image documentation #289

Add LXD and OpenStack image documentation #289

Conversation

mstpn commented Oct 23, 2024

codyshepherd left a comment

Choose a reason for hiding this comment

k-dimple left a comment

Choose a reason for hiding this comment

k-dimple Nov 6, 2024

Choose a reason for hiding this comment

mstpn Nov 6, 2024

Choose a reason for hiding this comment

k-dimple Nov 7, 2024

Choose a reason for hiding this comment

mstpn Nov 8, 2024

Choose a reason for hiding this comment

k-dimple Nov 6, 2024

Choose a reason for hiding this comment

k-dimple Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

mstpn Nov 8, 2024 • edited Loading

Choose a reason for hiding this comment

k-dimple Nov 8, 2024

Choose a reason for hiding this comment

mstpn commented Nov 7, 2024

k-dimple left a comment • edited Loading

Choose a reason for hiding this comment

k-dimple Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

k-dimple Nov 7, 2024 •

edited

Loading

mstpn Nov 8, 2024 •

edited

Loading

k-dimple left a comment •

edited

Loading

k-dimple Nov 7, 2024 •

edited

Loading