Skip to content
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.

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

docs(nm): added documentation for vlan and mtu configuration #4919

Merged
merged 7 commits into from
Nov 8, 2023

Conversation

fdizazzo
Copy link
Contributor

Note: We are using the Conventional Commits convention for our pull request titles. Please take a look at the PR title format document for the supported types and scopes.

This PR adds documentation for #4877 and #4816

@mattdibi mattdibi self-requested a review October 27, 2023 13:05
Copy link
Contributor

@mattdibi mattdibi left a comment

Choose a reason for hiding this comment

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

LGTM

Only one thing: we think that the addition of the support for VLANs is so important that requires a dedicated page in the Network Configuration section on its own, like we did for "Network Failover" and "Wi-Fi 802.1x Configuration". Like this:

image

Obviously for now it will be a barebone page since we still don't have a UI, but will be updated in the future when we do.

The page should contain some basic info about what VLANs are, how Kura treats them, some further explaination of what parameters are required etc.

Do you think you can handle that?

@fdizazzo
Copy link
Contributor Author

Sure, but i'll need a few days :)

@mattdibi
Copy link
Contributor

@fdizazzo no problemo! 👍

Copy link
Contributor

@mattdibi mattdibi left a comment

Choose a reason for hiding this comment

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

Some minor issues, otherwise LGTM 👍 Once the issues are fixed I'll proceed with merging.

GJ @fdizazzo 😄

docs/gateway-configuration/vlan-configuration.md Outdated Show resolved Hide resolved
docs/gateway-configuration/vlan-configuration.md Outdated Show resolved Hide resolved
docs/gateway-configuration/vlan-configuration.md Outdated Show resolved Hide resolved
docs/gateway-configuration/vlan-configuration.md Outdated Show resolved Hide resolved
docs/gateway-configuration/vlan-configuration.md Outdated Show resolved Hide resolved
@fdizazzo
Copy link
Contributor Author

fdizazzo commented Nov 7, 2023

... and it's done 😃

@mattdibi mattdibi merged commit 7f6e7a7 into eclipse-kura:docs-develop Nov 8, 2023
2 checks passed
@mattdibi
Copy link
Contributor

mattdibi commented Nov 8, 2023

@fdizazzo thanks for your contribution 😄

github-actions bot pushed a commit that referenced this pull request Nov 8, 2023
* docs(nm): added documentation for vlan and mtu configuration

* fix: Delete nohup.out

* docs: vlan configuration details page

* docs: fixed typos, added example for reactivation

* docs: fixed typos and broken link in vlan configuration page

* Update docs/gateway-configuration/vlan-configuration.md

* Update docs/gateway-configuration/vlan-configuration.md

---------

Co-authored-by: Mattia Dal Ben <[email protected]>
(cherry picked from commit 7f6e7a7)
mattdibi pushed a commit that referenced this pull request Nov 8, 2023
…t docs-release-5.4] (#4958)

docs(nm): added documentation for VLAN and MTU configuration (#4919)

* docs(nm): added documentation for vlan and mtu configuration

* fix: Delete nohup.out

* docs: vlan configuration details page

* docs: fixed typos, added example for reactivation

* docs: fixed typos and broken link in vlan configuration page

* Update docs/gateway-configuration/vlan-configuration.md

* Update docs/gateway-configuration/vlan-configuration.md

---------

Co-authored-by: Mattia Dal Ben <[email protected]>
(cherry picked from commit 7f6e7a7)

Co-authored-by: fdizazzo <[email protected]>
@fdizazzo fdizazzo deleted the docs-develop branch December 5, 2023 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants