Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
giuliazanchi opened this issue Jun 28, 2024 · 17 comments
Open

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

giuliazanchi opened this issue Jun 28, 2024 · 17 comments
Labels
diátaxis Revise a document to better conform to its Diátaxis type edit Edit pre-existing documentation for consistency, style and application help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task size 3 Fix a known documentation issue (size 3/8)

Comments

@giuliazanchi
Copy link
Collaborator

giuliazanchi commented Jun 28, 2024

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.

@giuliazanchi giuliazanchi added help wanted We welcome community help with this issue edit Edit pre-existing documentation for consistency, style and application size 3 Fix a known documentation issue (size 3/8) how-to Create a edit a how-to to achieve a specific task diátaxis Revise a document to better conform to its Diátaxis type new Adding new or missing documentation for a specific tool, feature, or function. and removed new Adding new or missing documentation for a specific tool, feature, or function. labels Jun 28, 2024
@CBID2
Copy link
Contributor

CBID2 commented Jul 2, 2024

I can work on this @giuliazanchi

@giuliazanchi
Copy link
Collaborator Author

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
Copy link
Contributor

CBID2 commented Jul 2, 2024

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
Copy link
Collaborator Author

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
Copy link
Collaborator Author

giuliazanchi commented Jul 10, 2024

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
Copy link
Collaborator Author

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

@giuliazanchi
Copy link
Collaborator Author

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

@CBID2
Copy link
Contributor

CBID2 commented Aug 16, 2024

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

@giuliazanchi
Copy link
Collaborator Author

I am @giuliazanchi.

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

@CBID2
Copy link
Contributor

CBID2 commented Sep 6, 2024

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
Copy link
Collaborator Author

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

@giuliazanchi
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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
Copy link
Contributor

CBID2 commented Sep 25, 2024

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
Copy link
Collaborator Author

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
Copy link
Contributor

CBID2 commented Nov 7, 2024

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
diátaxis Revise a document to better conform to its Diátaxis type edit Edit pre-existing documentation for consistency, style and application help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task size 3 Fix a known documentation issue (size 3/8)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants