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

Netplan: Add info on building docs to README #52

Closed rkratky closed 3 months ago

rkratky commented 5 months ago

Context

The Netplan project docs are hosted within the same repo as the code, but the main repo README (or the CONTRIBUTING file) has no information on how to contribute to the docs. This an oversight, albeit one that should be simple to fix.

Task

The README should contain basic info on:

Inspiration: https://github.com/canonical/ubuntu-packaging-guide

ade555 commented 5 months ago

Hi, @rkratky please assign this issue to me. I should be done with it by COB tomorrow.

rkratky commented 3 months ago

Thank you, @ade555. Closing this issue as completed.