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

Create user guide for Wireless Networks #6639

Merged
merged 18 commits into from
Dec 23, 2024
Merged

Conversation

smk4664
Copy link
Contributor

@smk4664 smk4664 commented Dec 10, 2024

What's Changed

This is the user guide for Wireless Networks. We are using the Central Mode as an example as this utilizes the most features of Wireless Networks and Controllers.

Screenshots

image
image

image
image

TODO

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Unit, Integration Tests
  • Documentation Updates (when adding/changing features)
  • Example App Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design

Copy link
Contributor

@gsnider2195 gsnider2195 left a comment

Choose a reason for hiding this comment

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

Looks good! These suggestions are by no means required, I just think they will help readability.

Copy link
Contributor

@cmsirbu cmsirbu left a comment

Choose a reason for hiding this comment

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

My only criticism here would be that the data created in the guide is not linked to the opening diagram. Other users may not notice immediately that devices are just whatever existed on the demo sandbox and belong to mixed locations etc.

I was expecting that this guide would take users to a complete configuration of the topology presented at the start... so they can see how all the objects tie together in a real life scenario.

@smk4664
Copy link
Contributor Author

smk4664 commented Dec 13, 2024

My only criticism here would be that the data created in the guide is not linked to the opening diagram. Other users may not notice immediately that devices are just whatever existed on the demo sandbox and belong to mixed locations etc.

I was expecting that this guide would take users to a complete configuration of the topology presented at the start... so they can see how all the objects tie together in a real life scenario.

That was on purpose as I did not cover the creation of location or devices, plus the opening diagram was being replaced, the new diagram will use the names from Sandbox.

@cmsirbu
Copy link
Contributor

cmsirbu commented Dec 13, 2024

My only criticism here would be that the data created in the guide is not linked to the opening diagram. Other users may not notice immediately that devices are just whatever existed on the demo sandbox and belong to mixed locations etc.
I was expecting that this guide would take users to a complete configuration of the topology presented at the start... so they can see how all the objects tie together in a real life scenario.

That was on purpose as I did not cover the creation of location or devices, plus the opening diagram was being replaced, the new diagram will use the names from Sandbox.

I'd say there's no need to cover creation, but you could list out at the start the related objects (the names as used in the design, not just the types) that you'll be using which are already there for this whole design: Locations, Vlans, Devices, Platforms - and yes use as much of the new demo data as possible!

I think the screenshots are great and showcase the "how" (to add a particular object) step by step... and would benefit greatly from listing which objects you'd create for this design with real names and an explanation of the "why".

Remember, this should help a network operator/engineer transpose their network into Nautobot models by implementing a fully fledged example. What we need is a story to tie it all together "how do I go from my Visio diagram of the network to data in Nautobot that models it and allows me to automate deployment/verification etc?"

@gsnider2195 gsnider2195 marked this pull request as draft December 17, 2024 17:12
@smk4664 smk4664 marked this pull request as ready for review December 23, 2024 20:58
@smk4664 smk4664 merged commit 3f955b4 into next Dec 23, 2024
17 checks passed
@smk4664 smk4664 deleted the u/smk4664-wireless-user-guides branch December 23, 2024 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants