canonical / open-documentation-academy

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

Multipass: improve category landing pages #56

Closed rkratky closed 1 month ago

rkratky commented 2 months ago

Context

Multipass project docs are in a reasonably good shape, but there are (as always) little things that could be improved to offer better user experience. One of them is the use of language that's largely superfluous and doesn't help the user.

The 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.)

Task

Modify the landing pages for the four Diátaxis topic categories (tutorial, how-to, reference, explanation) to provide more context for the user. Visit Example landing page for an example.

Example

Page: https://multipass.run/docs/tutorials Old text: "Get started - a hands-on introduction to Multipass for new users." New text: "Get started - a hands-on introduction to Multipass for new users. These platform-specific tutorials teach you about creating and managing Multipass instances, and offer basic examples on how to use the instances."

nielsenjared commented 2 months ago

Hey @rkratky ! I'm interested in this issue. Can you set me up with the Markdown in this repo so I can work on a fork? I could also address #55 while I'm at it if no one picks it up.

rkratky commented 2 months ago

@nielsenjared, the files are ready for your contributions in the multipass/ directory.

giuliazanchi commented 1 month ago

Hi @nielsenjared, your contributions have been incorporated into the official Multipass documentation on Discourse: https://multipass.run/docs Thank you so much for your help!