docs: Add documentation for specifying VLAN ID

[Precious000]

Enhancement Reason: To provide users with clear guidance on how to specify VLAN ID and settings for the "vlan" type, improving usability and clarity in network configuration.

Result: Users can now easily understand and configure VLAN-related settings using the updated documentation, leading to more efficient network setups.

Issue Tracker Tickets (Jira or BZ if any): [#491]

[Precious000]

Hi @tyll can you please check the changes and accept pr, are there any corrections?

[liangwen12year]

vlan_id was already deprecated since 72f7c8ab4dd7d79b2a86bc38ef04382f0705461e, and the nested vlan is preferred.

-    vlan_id: 6
+    vlan:
+      id: 6

[liangwen12year]

Do not forget to sign your commit by using git commit -s.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 43.22%. Comparing base (34d1f2d) to head (7168a41). Report is 7 commits behind head on main.

:exclamation: Current head 7168a41 differs from pull request most recent head cfe3b1d

Please upload reports for the commit cfe3b1d to get more accurate results.

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #685       +/-   ##
===========================================
+ Coverage   20.50%   43.22%   +22.72%     
===========================================
  Files          10       12        +2     
  Lines        1478     3100     +1622     
  Branches      433        0      -433     
===========================================
+ Hits          303     1340     +1037     
- Misses       1174     1760      +586     
+ Partials        1        0        -1     

Flag	Coverage Δ
sanity	?

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[liangwen12year]

PR Title lint is failed, type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test, tests] [type-enum], please change the title for the PR to docs: Add documentation for specifying VLAN ID.

[Precious000]

type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test, tests] [type-enum]

Hi @liangwen12year I just did. Thanks a lot. Is there any more to be corrected, Sir?

[Precious000]

Hi @liangwen12year can you please checkout what I’ve done? And please accept the pr?

[liangwen12year]

Can you rebase the current PR, git pull --rebase upstream main

[richm]

You'll need to rebase the PR on top of the latest main branch. If you aren't sure how to do that, please ask.