Skip to content

docs: IPv6 config examples with content tabs#3436

Merged
polarathene merged 5 commits intomasterfrom
docs/improved-ipv6-config-with-snippets
Jul 20, 2023
Merged

docs: IPv6 config examples with content tabs#3436
polarathene merged 5 commits intomasterfrom
docs/improved-ipv6-config-with-snippets

Conversation

@polarathene
Copy link
Copy Markdown
Member

@polarathene polarathene commented Jul 20, 2023

Description

For added clarity, a user requested we document the example config snippets instead of only linking external references to them.

Some content has been shuffled around and revised, the nginx-proxy comment link removed (replaced with simpler networks syntax, and same as typical user-defined network creation, reduced to a small tip on default overriding), content tabs for presentation all within a single example admonition.

This is a follow-up to the rewrite of IPv6 docs I did recently at: #3244

Resolves: #3422

Type of change

  • Improvement (non-breaking change that does improve existing functionality)

Preview

Direct preview link to updated section: https://pullrequest-3436--dms-doc-previews.netlify.app/config/advanced/ipv6/#enable-proper-ipv6-support

Revised version

Screenshot_20230720_205718

Prior version

Screenshot_20230720_205825

For added clarity, a user requested we document the example config snippets instead of only linking externally.

Some content has been shuffled around and revised, the nginx-proxy comment link removed, content tabs for presentation all within a single example admonition.
@polarathene polarathene added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Jul 20, 2023
@polarathene polarathene added this to the v13.0.0 milestone Jul 20, 2023
@polarathene polarathene self-assigned this Jul 20, 2023
Some additional context and revised wording. Admonitions given titles.
@polarathene polarathene enabled auto-merge (squash) July 20, 2023 09:11
@polarathene
Copy link
Copy Markdown
Member Author

@AlperShal hopefully this is what you roughly had in mind 😅

If the content looks a bit too noisy, I could collapse the info and tip admonitions by default to compact the focus on what's important.

@AlperShal
Copy link
Copy Markdown

AlperShal commented Jul 20, 2023

This is even better than what I thought it should be. Thanks for the awesome work! Only thing I was going to say that there being too much information boxes but you already suggested some cool fix about that. Them being collapsed on default would make it much cleaner.

Copy link
Copy Markdown
Member Author

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

Hiding additional information by default to compact the instructions so they're focused on communicating the important info without excess noise.

Here's an updated screenshot with those changes, along with the other two tab views:

Screenshot_20230721_090014

Screenshot_20230721_090045

Screenshot_20230721_090108

Comment thread docs/content/config/advanced/ipv6.md Outdated
Comment thread docs/content/config/advanced/ipv6.md Outdated
Comment thread docs/content/config/advanced/ipv6.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 3d6c768

@polarathene
Copy link
Copy Markdown
Member Author

Ready for review, auto-merge is all set to go when another maintainer approves 👍

@polarathene polarathene merged commit a0fde8b into master Jul 20, 2023
@polarathene polarathene deleted the docs/improved-ipv6-config-with-snippets branch July 20, 2023 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

other: Make iPv6 documentation more understandable

3 participants