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

Improve language in multipass/Linux.md #91

Closed PitifulPete closed 5 days ago

PitifulPete commented 2 weeks ago

Did things like (https://github.com/canonical/open-documentation-academy/issues/55 ): made sentences more concise, aligned writing with canonical documentation guideline by ensuring that words and phrases that should be avoided are avoided - pronouns are used right and consistently - and words are British instead of American, corrected grammatical errrors by using words (like the word , spotting when it is used as an adverb and when it is not) and punctuations properly, and re-wrote confusing sentences.

Will work on Windows and macOS. Wanted to push this and get response on whether it is being done right

giuliazanchi commented 2 weeks ago

Hi @PitifulPete, I wanted to let you know that I have merged the 3 tutorials into a single one (check it out here: How to install Multipass), but you can still find the original tutorials on Discourse:

Please keep working on individual files, it will be easier to compare diffs & merge changes! Thank you, Giulia

PitifulPete commented 2 weeks ago

Hi @PitifulPete, I wanted to let you know that I have merged the 3 tutorials into a single one (check it out here: How to install Multipass), but you can still find the original tutorials on Discourse:

Please keep working on individual files, it will be easier to compare diffs & merge changes! Thank you, Giulia

I'm working on tutorials (get started with Multipass), not how-to, and that still seems to be separated in the link you shared. Or am i missing something?

giuliazanchi commented 2 weeks ago

@PitifulPete You are absolutely right :D I have just finished merging the "how-to install" guides on Discourse and am in the process of merging the Tutorials as well, hence the confusion on my part! Apologies, and yes, please keep working on the three separate files.

PitifulPete commented 1 week ago

@giuliazanchi, worked on all three files. what do you think?

PitifulPete commented 5 days ago

Done, @giuliazanchi

PitifulPete commented 5 days ago

Great work, @PitifulPete ! Thank you so much for your contribution to Multipass documentation, I will merge this PR and make sure to incorporate your changes into our Discourse pages ASAP. I'll also add you to the list of contributors at the bottom of the page.

I hope you enjoyed working on these docs, I was glad to discuss and review your proposed changes, some of them were very much needed and some definitely nice to have. Looking forward to seeing you again in the Canonical Open Documentation Academy :)

Thank you, @giuliazanchi . Really appreciate your time and effort 🙏. Will definitely be around