canonical / open-documentation-academy

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

Anbox Cloud: Improve contributing guide #131

Open keirthana opened 3 weeks ago

keirthana commented 3 weeks ago

Context

The Anbox Cloud documentation includes a contributing guide. However, it is not intuitive from the TOC. It also lacks information about the checks that need to be passed when creating a PR to the Anbox Cloud documentation repository.

Task

Reference Diataxis: How-to guides A good example of a contributing guide: LXD contributing guide

faithuniterh commented 2 weeks ago

I would like to work on this

keirthana commented 2 weeks ago

I would like to work on this

Thannk you @faithuniterh, please have a look at the resources linked and let me know if you need any additional information.

keirthana commented 1 week ago

@faithuniterh I see that you have created a PR for "Rename the Project and Community TOC heading to Contribute. (Retain the style guide as a sub topic)".

Are you working on the remaining points of this issue on the same PR?

keirthana commented 4 days ago

@faithuniterh Will you be able to continue working on the remaining parts of the issue?

faithuniterh commented 3 days ago

@keirthana My intention is to work under the same PR, unless stated otherwise Yes I will be able to continue working on the remaining parts.

keirthana commented 3 days ago

@keirthana My intention is to work under the same PR, unless stated otherwise Yes I will be able to continue working on the remaining parts.

Thank you, I will review once all the changes are in.