search

canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation
Apache License 2.0
48 stars 28 forks source link

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

Open giuliazanchi opened 4 days ago

giuliazanchi commented 4 days ago

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.

CBID2 commented 19 hours ago

I can work on this @giuliazanchi

giuliazanchi commented 19 hours ago

Thank you @CBID2 ! Feel free to ask any questions, if needed :)

P.S. Are you able to work on Discourse? If not, please let me know, and I'll add Markdown files to the Open Documentation Academy repo for you to work on.

CBID2 commented 19 hours ago

Thank you @CBID2 ! Feel free to ask any questions, if needed :)

P.S. Are you able to work on Discourse? If not, please let me know, and I'll add Markdown files to the Open Documentation Academy repo for you to work on.

Yes I can @giuliazanchi! Can you add it to the repo too?