Skip to content

Tutorial improvements#458

Merged
slyon merged 4 commits intocanonical:mainfrom
rkratky:FR-2811_tutorial
Apr 24, 2024
Merged

Tutorial improvements#458
slyon merged 4 commits intocanonical:mainfrom
rkratky:FR-2811_tutorial

Conversation

@rkratky
Copy link
Contributor

@rkratky rkratky commented Apr 18, 2024

Description

This PR revamps the Netplan tutorial:

  • Some reorg for better flow.
  • Extensive language and formatting improvements.
  • Moves parts to 'how-to guides' where appropriate.
  • Tutorial landing page improved.

In addition:

  • How-to guides landing page slightly improved in structure (to be revisited).
  • Minor lang. + mark-up fixes in YAML reference.

Fixes FR-2811.

@rkratky rkratky requested a review from slyon April 18, 2024 16:33
@rkratky rkratky added the documentation Documentation improvements. label Apr 18, 2024
Copy link
Contributor

@slyon slyon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much, Robert!

I very much like the breaking down of the big tutorial into smaller chunks and the overall structural improvements.

I wonder if the new how-to guides should be linked from the bottom of the tutorial, e.g. in a "Future reading" section or so?

I've left a few inline comments of broken links and one logical question wrt IPv6 addresses which shouldn't be there.. Those should be fixed before merging.

@daniloegea Do you have anything to add to this, as it was your document intially?

Copy link
Contributor

@daniloegea daniloegea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Robert. I looks good. I just found a typo you might want to fix.

Copy link
Contributor

@slyon slyon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing the remarks! LGTM

note: I pushed a tiny fix for whitespace formatting in the CLI output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants