added guide for contributing to the netplan documentation by ade555 · Pull Request #457 · canonical/netplan

ade555 · 2024-04-18T09:26:08Z

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 · 2024-04-18T10:55:26Z

doc/contribute-docs.md

+These steps will show you how to build the documentation on your local machine.
+1. To build this documentation, first create a fork of the [Netplan repository](https://github.com/canonical/netplan) and clone that into your machine. For example:
+    ```shell
+    git clone [email protected]:ade555/netplan.git


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 :)

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 · 2024-04-18T14:44:18Z

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

ade555 · 2024-04-26T07:20:53Z

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

rkratky · 2024-04-26T14:15:30Z

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

Apologies, this slipped through the cracks.

I will submit a review soon.

ade555 · 2024-04-26T14:21:00Z

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.

doc/contribute-docs.md

ade555 · 2024-05-02T05:55:14Z

@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 · 2024-05-02T10:45:29Z

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 · 2024-05-02T14:13:28Z

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 · 2024-05-05T15:24:04Z

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 · 2024-05-07T13:45:38Z

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 · 2024-05-08T17:25:33Z

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 · 2024-05-20T13:48:16Z

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.

doc/contribute-docs.md

rkratky

Thank you, @ade555. A few more nitpicks.

README.md

doc/contribute-docs.md

ade555 · 2024-06-05T09:48:28Z

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.

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

…ally

…ot work

Co-authored-by: Robert Krátký <[email protected]>

Co-authored-by: Lukas Märdian <[email protected]>

slyon · 2024-06-06T09:03:55Z

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

ade555 · 2024-06-20T15:55:06Z

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

daniloegea reviewed Apr 18, 2024

View reviewed changes

slyon added community This PR has been proposed by somebody outside of the Netplan team and roadmap commitments. documentation Documentation improvements. labels Apr 18, 2024

slyon requested a review from rkratky April 18, 2024 10:58

rkratky requested changes May 1, 2024

View reviewed changes

ade555 requested a review from rkratky May 2, 2024 10:42

slyon approved these changes May 29, 2024

View reviewed changes

doc/contribute-docs.md Outdated Show resolved Hide resolved

doc/contribute-docs.md Show resolved Hide resolved

rkratky requested changes May 31, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

doc/contribute-docs.md Outdated Show resolved Hide resolved

doc/contribute-docs.md Outdated Show resolved Hide resolved

doc/contribute-docs.md Outdated Show resolved Hide resolved

rkratky approved these changes Jun 5, 2024

View reviewed changes

superherojt and others added 9 commits June 6, 2024 11:00

added guide for contributing to the netplan documentation

a5a4317

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

fixed spelling error and added info for testing the documentation loc…

2094b43

…ally

changed github ssh link to a generic link

5fa763e

added note to install aspell in case the make spelling command does n…

25c5655

…ot work

Update doc/contribute-docs.md

3c47447

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

6440e72

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

8ea8e38

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

109bfe3

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

cbc9a14

Co-authored-by: Robert Krátký <[email protected]>

ade555 and others added 19 commits June 6, 2024 11:02

Update doc/contribute-docs.md

3800ea3

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

c1d24ae

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

2c1bec3

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

ebb97b8

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

d66c699

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

284c432

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

2a7d314

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

79b3cc5

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

59edbd8

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

f50c110

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

406a0ac

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

cfa6db5

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

216c948

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

c1df907

Co-authored-by: Robert Krátký <[email protected]>

Update doc/contribute-docs.md

ebecfda

Co-authored-by: Robert Krátký <[email protected]>

implemented feedback and added overview to readme.md

d28b906

implemented feedback and added overview to readme.md

53f8eed

Update doc/contribute-docs.md

6d70cca

Co-authored-by: Lukas Märdian <[email protected]>

implemented corrections

03a4787

slyon force-pushed the doc/contributing branch from 8acbe34 to 03a4787 Compare June 6, 2024 09:02

slyon merged commit 1e1d80c into canonical:main Jun 6, 2024

ade555 deleted the doc/contributing branch June 20, 2024 15:55

Conversation

ade555 commented Apr 18, 2024 • edited by slyon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

daniloegea Apr 18, 2024

Choose a reason for hiding this comment

Uh oh!

ade555 Apr 18, 2024

Choose a reason for hiding this comment

Uh oh!

slyon commented Apr 18, 2024

Uh oh!

ade555 commented Apr 26, 2024

Uh oh!

rkratky commented Apr 26, 2024

Uh oh!

ade555 commented Apr 26, 2024

Uh oh!

rkratky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ade555 commented May 2, 2024

Uh oh!

ade555 commented May 2, 2024

Uh oh!

rkratky commented May 2, 2024

Uh oh!

ade555 commented May 5, 2024

Uh oh!

slyon commented May 7, 2024

Uh oh!

ade555 commented May 8, 2024

Uh oh!

ade555 commented May 20, 2024

Uh oh!

slyon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rkratky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ade555 commented Jun 5, 2024

Uh oh!

rkratky left a comment

Choose a reason for hiding this comment

Uh oh!

slyon commented Jun 6, 2024

Uh oh!

ade555 commented Jun 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ade555 commented Apr 18, 2024 •

edited by slyon

Loading