canonical/open-documentation-academy

Multipass: Split sub how-tos out of "How to set up the driver"

Open

#111 opened on Jun 28, 2024

 (21 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
diátaxisedithelp wantedhow-tosize 3

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (PR metrics pending)

Description

Context

Multipass docs are in reasonably good shape, but there are (as always) little things that could be improved to offer a better user experience.

Multipass docs are maintained in and published from the Ubuntu Discourse forum. To suggest changes in a Discourse-hosted docs page, scroll all the way down to the bottom of the page and open the page to which the "Help improve this document in the forum" link points. On the Discourse page, scroll to the bottom of the article (if there are comments, then the bottom of the article is just where the comments start, i.e. not at the very bottom of the page) and click "Edit". (You need an account on Ubuntu Discourse.) See also: Contribute to Multipass docs.

Task

The How to set up the driver guide includes several seemingly unrelated recipes for Linux, macOS and Windows. It would be useful to split it into smaller, more specific how-to guides.

Useful links

Before you get started, make sure to review the main concepts of the Diátaxis documentation framework and also check the Canonical Documentation Style Guide.

If you are new to the Canonical Open Documentation Academy, you may also want to review our Getting Started topic on the Ubuntu Discourse forum.

Contributor guide