netplan icon indicating copy to clipboard operation
netplan copied to clipboard

Published 20 hours ago • verified publisher icon canonical

added guide for contributing to the netplan documentation

Open ade555 opened this issue 10 months ago • 10 comments

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

  • [x] Runs make check successfully.
  • [x] 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.

ade555 avatar Apr 18 '24 09:04 ade555

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

slyon avatar Apr 18 '24 14:04 slyon

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

ade555 avatar Apr 26 '24 07:04 ade555

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

Apologies, this slipped through the cracks.

I will submit a review soon.

rkratky avatar Apr 26 '24 14:04 rkratky

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

Thank you very much

ade555 avatar Apr 26 '24 14:04 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 avatar May 02 '24 05:05 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!

ade555 avatar May 02 '24 10:05 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.

rkratky avatar May 02 '24 14:05 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.

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

ade555 avatar May 05 '24 15:05 ade555

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.

slyon avatar May 07 '24 13:05 slyon

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 avatar May 08 '24 17:05 ade555

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

ade555 avatar May 20 '24 13:05 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?

ade555 avatar Jun 05 '24 09:06 ade555

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

slyon avatar Jun 06 '24 09:06 slyon

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

ade555 avatar Jun 20 '24 15:06 ade555