search

canonical / open-documentation-academy

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

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

Open giuliazanchi opened 4 months ago

giuliazanchi commented 4 months 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 4 months ago

I can work on this @giuliazanchi

giuliazanchi commented 4 months 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 4 months 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?

giuliazanchi commented 4 months ago

Hi @CBID2 , sorry for the late reply.

Can you add it to the repo too?

OK! I will upload the Markdown source file on the Open Documentation Academy repo and share the details here when done.

I also came here to say that I slightly rearranged the content to make better use of Discourse tabs, but you can still split 2 how-tos out of this one (in particular, I'm looking at sections "Use VirtualBox to set up port forwarding for a Multipass instance" and "Use VirtualBox to set up network bridging for a Multipass instance").

giuliazanchi commented 4 months ago

Hi again @CBID2 , here it is: https://github.com/canonical/open-documentation-academy/blob/main/multipass/how-to/how_to_set_up_the_driver.md

Let me know if you need help, thanks again for offering to work on this how-to!

P.s. If you see any other improvements to be made to this guide, feel free to submit them :)

giuliazanchi commented 3 months ago

Hi @CBID2 , just checking in to see if you need help with this task :) In case, we're available! Thanks again

giuliazanchi commented 3 months ago

Hi @CBID2 , here's a friendly ping just to check if you're still interested in giving this a go. Thanks!

CBID2 commented 3 months ago

I am @giuliazanchi. A lot has happened since we last spoke so I'm slowly coming back

giuliazanchi commented 3 months ago

I am @giuliazanchi.

Excellent! I'm available if you need me, looking forward to making progress on this issue :)

CBID2 commented 2 months ago

I am @giuliazanchi.

Excellent! I'm available if you need me, looking forward to making progress on this issue :)

Hi @giuliazanchi! :) I finally got to this issue. My PR is #139. It's in draft mode right now because I want to make sure it's the style that you had in mind.

giuliazanchi commented 2 months ago

Hi @CBID2 , that sounds great! I'll review your PR ASAP :)

giuliazanchi commented 2 months ago

I left a comment to your PR #139, let me know what you think :) I should have added this as part of the requirements, I didn't think about it.

giuliazanchi commented 1 month ago

Hi @CBID2 , I've been applying some fixes to the Multipass docs on Discourse. Before I update the markdown source on this repo, I wanted to check in with you and see if you've been able to dedicate more time to this issue.

Let me know if you need help! You can also find me in the Documentation room on Matrix if you want to chat.

CBID2 commented 1 month ago

Hi @CBID2 , I've been applying some fixes to the Multipass docs on Discourse. Before I update the markdown source on this repo, I wanted to check in with you and see if you've been able to dedicate more time to this issue.

Let me know if you need help! You can also find me in the Documentation room on Matrix if you want to chat.

Hey @giuliazanchi. Thanks for the update! :) I have not been able to make the changes. Still kind of lost. I also messaged you on Matrix so, we can chat there.

giuliazanchi commented 1 week ago

HI @CBID2 , are you still interested in contributing to this issue? If your availability has changed, no worries at all! Just let me know so I can free it up to other contributors :) Thanks!

CBID2 commented 1 week ago

HI @CBID2 , are you still interested in contributing to this issue? If your availability has changed, no worries at all! Just let me know so I can free it up to other contributors :) Thanks!

Hey @giuliazanchi. You can assign this issue to someone else.

Sophie-Pages commented 8 hours ago

Hi @giuliazanchi I would like to help. Could you please assign the issue to me? Thank you!