Skip to content

PD-2466 / 26.04 / Pd 2466 update network bridge and interface articles #4372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
micjohnson777 wants to merge 8 commits into
base: master
Choose a base branch
from
Open

PD-2466 / 26.04 / Pd 2466 update network bridge and interface articles #4372

micjohnson777 wants to merge 8 commits into from

Conversation

@micjohnson777
Copy link
Contributor

@micjohnson777 micjohnson777 commented Dec 22, 2025

This PR update the tutorial articles for /network/interfaces/_index.md, SettingUpVLAN.md, SettingUpLAGG.md and the files and snippets in the SettingUpBridge.md articles.

New snippets created for content common to all interface types.

Backport to 25.10

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

@micjohnson777
PD-2466 Update _index.md and SettingUpBridge.md
6ccc051 
This commit updates screenshots, and the content in the /network/interfaces/_index.md, and creates the TestingNetworkChanges.md and InterfaceBeforeYouBegin.md snippets. It updates the SettingUpBridge.md article and snippets: NetworkBridgeSCALE.md content.
@micjohnson777
Merge branch 'master' into PD-2466-Update-Network-Bridge-and-Interfac…
ecf1563 
…e-Articles
@micjohnson777
PD-2466 Update LAGG and VLAN Tutorials
e5eed7b 
This commit adds the new general interface snippets to the SettingUpLAGG.md and SettingUpVLAN.md articles.
@micjohnson777 micjohnson777 requested a review from a team as a code owner December 22, 2025 22:01
@bugclerk
Copy link
Contributor

bugclerk commented Dec 22, 2025

Jira URL: https://ixsystems.atlassian.net/browse/PD-2466

@bugclerk bugclerk changed the title Pd 2466 update network bridge and interface articles PD-2466 / 26.04 / Pd 2466 update network bridge and interface articles Dec 22, 2025
@github-actions
Copy link

github-actions bot commented Dec 23, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 56 issues found in changed files - 2 errors, 1 warnings, 53 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Network/Interfaces/_index.md (19 issues)

  • Lines 15, 75, 198 - suggestion: Keep sentences under 30 words
  • Lines 15, 60 - suggestion: Spell out 'LAGG' on first use
  • Lines 31, 33, 61, 67 - suggestion: Use active voice instead of passive voice
  • Lines 75, 168, 176 - suggestion: Spell out 'CIDR' on first use

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md (13 issues)

  • Lines 3, 10, 22, 28, 34, 39, 53, 64 - suggestion: Spell out 'LAGG' on first use
  • Line 39 - suggestion: Spell out 'IEEE' on first use
  • Line 41 - error: Use 'after' instead of 'once'
  • Line 48 - suggestion: Spell out 'SLOW' on first use
  • Line 50 - suggestion: Spell out 'FAST' on first use

static/includes/NetworkBridgeSCALE.md (11 issues)

  • Lines 7, 49, 53, 61, 62 - suggestion: Use active voice instead of passive voice
  • Line 61 - error: Don't add '(s)' to a singular noun. Use plural instead.

static/includes/TestingNetworkChanges.md (5 issues)

  • Line 10 - suggestion: Use active voice instead of passive voice
  • Line 17 - suggestion: Keep sentences under 30 words
  • Line 27 - warning: For a general audience, use 'address' rather than 'URL'.

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md (4 issues)

  • Line 15 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Spell out 'FAQ' on first use
  • Line 18 - suggestion: Spell out 'LAGG' on first use
  • Line 19 - suggestion: Use active voice instead of passive voice

static/includes/InterfaceBeforeYouBegin.md (3 issues)

  • Line 6 - suggestion: Keep sentences under 30 words
  • Line 16 - suggestion: Use 'backup' instead of 'Back up'

static/includes/NetworkInterfaceTypes.md (1 issues)

  • Line 3 - suggestion: Spell out 'LAGG' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions
Copy link

github-actions bot commented Dec 23, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 56 issues found in changed files - 2 errors, 1 warnings, 53 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Network/Interfaces/_index.md (19 issues)

  • Lines 15, 75, 198 - suggestion: Keep sentences under 30 words
  • Lines 15, 60 - suggestion: Spell out 'LAGG' on first use
  • Lines 31, 33, 61, 67 - suggestion: Use active voice instead of passive voice
  • Lines 75, 168, 176 - suggestion: Spell out 'CIDR' on first use

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md (13 issues)

  • Lines 3, 10, 22, 28, 34, 39, 53, 64 - suggestion: Spell out 'LAGG' on first use
  • Line 39 - suggestion: Spell out 'IEEE' on first use
  • Line 41 - error: Use 'after' instead of 'once'
  • Line 48 - suggestion: Spell out 'SLOW' on first use
  • Line 50 - suggestion: Spell out 'FAST' on first use

static/includes/NetworkBridgeSCALE.md (11 issues)

  • Lines 7, 49, 53, 61, 62 - suggestion: Use active voice instead of passive voice
  • Line 61 - error: Don't add '(s)' to a singular noun. Use plural instead.

static/includes/TestingNetworkChanges.md (5 issues)

  • Line 10 - suggestion: Use active voice instead of passive voice
  • Line 17 - suggestion: Keep sentences under 30 words
  • Line 27 - warning: For a general audience, use 'address' rather than 'URL'.

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md (4 issues)

  • Line 15 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Spell out 'FAQ' on first use
  • Line 18 - suggestion: Spell out 'LAGG' on first use
  • Line 19 - suggestion: Use active voice instead of passive voice

static/includes/InterfaceBeforeYouBegin.md (3 issues)

  • Line 6 - suggestion: Keep sentences under 30 words
  • Line 16 - suggestion: Use 'backup' instead of 'Back up'

static/includes/NetworkInterfaceTypes.md (1 issues)

  • Line 3 - suggestion: Spell out 'LAGG' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions
Copy link

github-actions bot commented Dec 29, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 56 issues found in changed files - 2 errors, 1 warnings, 53 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Network/Interfaces/_index.md (19 issues)

  • Lines 15, 75, 198 - suggestion: Keep sentences under 30 words
  • Lines 15, 60 - suggestion: Spell out 'LAGG' on first use
  • Lines 31, 33, 61, 67 - suggestion: Use active voice instead of passive voice
  • Lines 75, 168, 176 - suggestion: Spell out 'CIDR' on first use

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md (13 issues)

  • Lines 3, 10, 22, 28, 34, 39, 53, 64 - suggestion: Spell out 'LAGG' on first use
  • Line 39 - suggestion: Spell out 'IEEE' on first use
  • Line 41 - error: Use 'after' instead of 'once'
  • Line 48 - suggestion: Spell out 'SLOW' on first use
  • Line 50 - suggestion: Spell out 'FAST' on first use

static/includes/NetworkBridgeSCALE.md (11 issues)

  • Lines 7, 49, 53, 61, 62 - suggestion: Use active voice instead of passive voice
  • Line 61 - error: Don't add '(s)' to a singular noun. Use plural instead.

static/includes/TestingNetworkChanges.md (5 issues)

  • Line 10 - suggestion: Use active voice instead of passive voice
  • Line 17 - suggestion: Keep sentences under 30 words
  • Line 27 - warning: For a general audience, use 'address' rather than 'URL'.

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md (4 issues)

  • Line 15 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Spell out 'FAQ' on first use
  • Line 18 - suggestion: Spell out 'LAGG' on first use
  • Line 19 - suggestion: Use active voice instead of passive voice

static/includes/InterfaceBeforeYouBegin.md (3 issues)

  • Line 6 - suggestion: Keep sentences under 30 words
  • Line 16 - suggestion: Use 'backup' instead of 'Back up'

static/includes/NetworkInterfaceTypes.md (1 issues)

  • Line 3 - suggestion: Spell out 'LAGG' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@linzi-ix linzi-ix added the Technical Writer Review (LM) A technical writer is reviewing the PR. label Dec 29, 2025
linzi-ix
linzi-ix reviewed Dec 29, 2025
View reviewed changes
linzi-ix
linzi-ix requested changes Dec 29, 2025
View reviewed changes
Copy link
Contributor

@linzi-ix linzi-ix left a comment

Choose a reason for hiding this comment

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

One question about the images

@github-actions
Copy link

github-actions bot commented Jan 6, 2026 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 56 issues found in changed files - 2 errors, 1 warnings, 53 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Network/Interfaces/_index.md (19 issues)

  • Lines 15, 75, 198 - suggestion: Keep sentences under 30 words
  • Lines 15, 60 - suggestion: Spell out 'LAGG' on first use
  • Lines 31, 33, 61, 67 - suggestion: Use active voice instead of passive voice
  • Lines 75, 168, 176 - suggestion: Spell out 'CIDR' on first use

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md (13 issues)

  • Lines 3, 10, 22, 28, 34, 39, 53, 64 - suggestion: Spell out 'LAGG' on first use
  • Line 39 - suggestion: Spell out 'IEEE' on first use
  • Line 41 - error: Use 'after' instead of 'once'
  • Line 48 - suggestion: Spell out 'SLOW' on first use
  • Line 50 - suggestion: Spell out 'FAST' on first use

static/includes/NetworkBridgeSCALE.md (11 issues)

  • Lines 7, 49, 53, 61, 62 - suggestion: Use active voice instead of passive voice
  • Line 61 - error: Don't add '(s)' to a singular noun. Use plural instead.

static/includes/TestingNetworkChanges.md (5 issues)

  • Line 10 - suggestion: Use active voice instead of passive voice
  • Line 17 - suggestion: Keep sentences under 30 words
  • Line 27 - warning: For a general audience, use 'address' rather than 'URL'.

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md (4 issues)

  • Line 15 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Spell out 'FAQ' on first use
  • Line 18 - suggestion: Spell out 'LAGG' on first use
  • Line 19 - suggestion: Use active voice instead of passive voice

static/includes/InterfaceBeforeYouBegin.md (3 issues)

  • Line 6 - suggestion: Keep sentences under 30 words
  • Line 16 - suggestion: Use 'backup' instead of 'Back up'

static/includes/NetworkInterfaceTypes.md (1 issues)

  • Line 3 - suggestion: Spell out 'LAGG' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@micjohnson777
PD-2666 Blur Network Addresses in Images
610e1bf 
This commit blurs the IP addresses in two images
@micjohnson777
Merge branch 'PD-2466-Update-Network-Bridge-and-Interface-Articles' of …
2a55400 
…https://github.com/truenas/documentation into PD-2466-Update-Network-Bridge-and-Interface-Articles
@github-actions
Copy link

github-actions bot commented Jan 6, 2026

Vale Style Guide Issues

📊 Summary: 56 issues found in changed files - 2 errors, 1 warnings, 53 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Network/Interfaces/_index.md (19 issues)

  • Lines 15, 75, 198 - suggestion: Keep sentences under 30 words
  • Lines 15, 60 - suggestion: Spell out 'LAGG' on first use
  • Lines 31, 33, 61, 67 - suggestion: Use active voice instead of passive voice
  • Lines 75, 168, 176 - suggestion: Spell out 'CIDR' on first use

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpLAGG.md (13 issues)

  • Lines 3, 10, 22, 28, 34, 39, 53, 64 - suggestion: Spell out 'LAGG' on first use
  • Line 39 - suggestion: Spell out 'IEEE' on first use
  • Line 41 - error: Use 'after' instead of 'once'
  • Line 48 - suggestion: Spell out 'SLOW' on first use
  • Line 50 - suggestion: Spell out 'FAST' on first use

static/includes/NetworkBridgeSCALE.md (11 issues)

  • Lines 7, 49, 53, 61, 62 - suggestion: Use active voice instead of passive voice
  • Line 61 - error: Don't add '(s)' to a singular noun. Use plural instead.

static/includes/TestingNetworkChanges.md (5 issues)

  • Line 10 - suggestion: Use active voice instead of passive voice
  • Line 17 - suggestion: Keep sentences under 30 words
  • Line 27 - warning: For a general audience, use 'address' rather than 'URL'.

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md (4 issues)

  • Line 15 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 16 - suggestion: Spell out 'FAQ' on first use
  • Line 18 - suggestion: Spell out 'LAGG' on first use
  • Line 19 - suggestion: Use active voice instead of passive voice

static/includes/InterfaceBeforeYouBegin.md (3 issues)

  • Line 6 - suggestion: Keep sentences under 30 words
  • Line 16 - suggestion: Use 'backup' instead of 'Back up'

static/includes/NetworkInterfaceTypes.md (1 issues)

  • Line 3 - suggestion: Spell out 'LAGG' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

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

Reviewers

@linzi-ix linzi-ix linzi-ix requested changes

@BonnieF BonnieF Awaiting requested review from BonnieF

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

backport-25.10 Re-Review Technical Writer Review (LM) A technical writer is reviewing the PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@micjohnson777 @bugclerk @linzi-ix