search

canonical / open-documentation-academy

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

Fix issue #53 (undescriptive text for link in Multipass docs) #61

Closed bagustris closed 3 months ago

bagustris commented 5 months ago

I tried using the keyword "here" in Multipass docs and replaced it with descriptive words. I also made some minor edits (e.g., macOS --> macOS).

Let me know if there are pages that need to be edited regarding this PR.

@rkratky

giuliazanchi commented 3 months ago

Hi @bagustris, I am so sorry for the long wait; your contribution and PR must have slipped through the cracks. I'll review your proposed changes ASAP.

giuliazanchi commented 3 months ago

Hi @bagustris , I've accepted your suggested changes to the "How to install" pages, I will implement them on Discourse.

As for the Linux tutorial, good idea to add quotes to the name of the instance, I've added this change (PR #83) to the markdown file that another contributor will be working on.

There is one small mistake though, where you suggest fixing the link:

To install it on your OS of choice, please follow the instructions given how-to guides.

If you read the resulting sentence carefully ("follow the instructions given how-to guides"), you'll notice it can be improved by adding a preposition and perhaps an article, for example: "follow the instructions given in the how-to guides", or something along these lines.

Please fix it, or let me know I should fix it for you; I thought it would be useful to share my feedback with you for future reference.

Thank you so much for your help!

bagustris commented 3 months ago

I fixed it, kindly check it.

giuliazanchi commented 3 months ago

@bagustris I'm closing this PR, no need to merge it as the official source of these pages is on Discourse anyway, and since these are small changes I'll apply them manually over there. Thank you again for taking the time to contribute to the Open Documentation Academy and, in particular, Multipass documentation, it is much appreciated!

P.S. If you are interested in Multipass, we have recently implemented a documentation feedback mechanism, which I am currently rolling out to all subpages. Have a look at https://multipass.run/docs , you'll find it at the top of the page :)