Skip to content

Generalize documents to clarify distro support#618

Open
Britel wants to merge 4 commits intomainfrom
user/britel/generalize-docs
Open

Generalize documents to clarify distro support#618
Britel wants to merge 4 commits intomainfrom
user/britel/generalize-docs

Conversation

@Britel
Copy link
Contributor

@Britel Britel commented Mar 6, 2026

This pull request updates documentation for the Image Customizer tool to generalize references from "Azure Linux" to "Linux" and clarify support for other distributions. The changes improve accuracy, inclusivity, and clarity across guides, API docs, and how-to instructions.


Checklist

  • Tests added/updated (Doc only change)
  • Documentation updated (if needed)
  • Code conforms to style guidelines

@Britel Britel requested a review from a team as a code owner March 6, 2026 00:26
Where:

- `<base-image.vhdx>`: An official Azure Linux vhdx image file.
- `<base-image.vhdx>`: An official Linux vhdx image file.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would change this to: A supported Linux vhdx image file.

This will make it consistent with the other docs where you used the word supported.


1. Download an Azure Linux VHDX image file.
- You can [download a marketplace image from Azure](../how-to/azure-vm/download-marketplace-image.md).
- You can also download and build one from the [Azure Linux repo](https://github.com/microsoft/azurelinux).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the second bullet point removed is still useful if users who want to build from source. Same comment in docs/imagecustomizer/quick-start/quick-start.md, is this intentional?

1. Download an Azure Linux VHDX image file.
- You can [download a marketplace image from Azure](../how-to/azure-vm/download-marketplace-image.md).
- You can also download and build one from the [Azure Linux repo](https://github.com/microsoft/azurelinux).
1. Download a supported Linux VHDX image file.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: there is a double space typo between supported and Linux.

2. Create a customization config file.

For example:
For example, in for Azure Linux:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: remove "in"

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.

3 participants