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 reference page for the multipass mount command needs to be improved, as it currently only lists the output of multipass help mount.
Make sure to cover both classic and native mounts, which are briefly described here: Mount.
For this task, you may take inspiration from other pages in the Command-Line Interface section or apply a different approach, as long as you don't revolutionise the template (otherwise, we'd have to update all other pages as well for consistency!) and include the output of multipass help mount at the bottom of the page. Please note that CLI reference pages are not yet auto-generated from the code but maintained manually.
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 reference page for the
multipass mountcommand needs to be improved, as it currently only lists the output ofmultipass help mount.Make sure to cover both classic and native mounts, which are briefly described here: Mount.
For this task, you may take inspiration from other pages in the Command-Line Interface section or apply a different approach, as long as you don't revolutionise the template (otherwise, we'd have to update all other pages as well for consistency!) and include the output of
multipass help mountat the bottom of the page. Please note that CLI reference pages are not yet auto-generated from the code but maintained manually.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.