added guide for contributing to the netplan documentation

[ade555]

modified the doc/contribute-docs.md file to include information about building the documentation locally and other information to successfully contribute to the documentation

Description

Checklist

• Runs make check successfully.
• Retains 100% code coverage (make check-coverage).
• New/changed keys in YAML format are documented.
• (Optional) Adds example YAML for new feature.
• (Optional) Closes an open bug in Launchpad.

[daniloegea]

Thanks for your contribution. May I ask you to change this to a generic github link instead of your own? Some people tend to copy and paste things verbatim :)

[ade555]

Thanks for your contribution. May I ask you to change this to a generic github link instead of your own? Some people tend to copy and paste things verbatim :)

Definitely. I'll change it right now.

[slyon]

@rkratky May I ask you to take a look at this?

[ade555]

Hi, @rkratky is there any progress on this, yet?

[rkratky]

Hi, @rkratky is there any progress on this, yet?

Apologies, this slipped through the cracks.

I will submit a review soon.

[ade555]

Apologies, this slipped through the cracks.
I will submit a review soon.

Thank you very much

[rkratky]

@ade555, thanks a lot for the PR. I submitted my review with suggestions (apologies for taking so long).

Aside: the issue (Netplan: Add info on building docs to README) asked for info to be added to the repo's README.md file. That should be just a very brief overview. From there, we can link to this page in docs.

[ade555]

@ade555, thanks a lot for the PR. I submitted my review with suggestions (apologies for taking so long).

Aside: the issue (Netplan: Add info on building docs to README) asked for info to be added to the repo's README.md file. That should be just a very brief overview. From there, we can link to this page in docs.

I'll work on this and submit a PR today.

[ade555]

Hi, @rkratky. I worked on your suggestions already and made corrections where necessary. I have also included an overview to the readme file. Please check it out and let me know what you think.

Currently, two checks are failing, but they're not documentation checks and I didn't touch the code base, so I'm assuming it's safe for me to ignore them. If not, please point me in the right direction to fix them. Thank you!

[rkratky]

Excellent, thank you.

I'm off until next week, and then I'll be in company meetings most of the time, but I'll try to get back to you at soon as possible. Again, apologies for the delays.

[ade555]

Excellent, thank you.

I'm off until next week, and then I'll be in company meetings most of the time, but I'll try to get back to you at soon as possible. Again, apologies for the delays.

No problem about that, @rkratky. Enjoy your break!

[slyon]

Currently, two checks are failing, but they're not documentation checks and I didn't touch the code base, so I'm assuming it's safe for me to ignore them.

The "Run spread" and "Autopkgtest DebCI" checks are known (temporary) failures and can be safely ignored for this PR.

[ade555]

The "Run spread" and "Autopkgtest DebCI" checks are known (temporary) failures and can be safely ignored for this PR.

Okay, then. Thank you very much for letting me know @slyon.

[ade555]

Hi, @rkratky are you available to give this a quick look now?

[slyon]

Thank you very much for your contribution to Netplan!

This is generally looking good to me, so it can be merged once we receive Robert's +1.
I left two tiny inline-comments that you should consider fixing first, though.

[rkratky]

Thank you, @ade555. A few more nitpicks.

[ade555]

Hi, @rkratky I made a PR just now to fix all the issues you pointed out. Please check and revert when you can.

I noticed a documentation test is failing (specifically the link check test) but everything seems fine when I run it locally. Can you give me tips to debug the issue?

[rkratky]

Thank you.

@slyon, this is good to be merged for mow.

[slyon]

Rebased, should now be ready for merging. Thanks again for your contribution to Netplan @ade555 !

[ade555]

Hi, @slyon and @rkratky. Thank you very much for your help and corrections during this process! Let's do this some other time!