OSRB review

[mzbroch]

No description provided.

[progala]

I'll commit suggestions and updates once I've got my rights fixed.

For now, here are some generic comments:

Some, but not all, models have attributes listed in a list. We should update all model descriptions to follow the same format. Example format with attributes enumerated is here:

https://github.com/nautobot/nautobot-plugin-firewall-models/blob/develop/docs/models/policy.md

- It'd be good to include a section with an example illustrating the order in which objects should be created. Example of how we did it for the FW models:

https://github.com/nautobot/nautobot-plugin-firewall-models/blob/develop/docs/models.md#creation-order

- There is no mention of where in GUI these models are exposed.

- The name of the models don't always match the names in the GUI. It might be helpful to include a table with the mappings. Alternatively include the GUI name in the description of each model.

- Extra Attributes section should be moved above models referring to it. Alternatively, provide a link in the model descriptions.

- Split README.md into multiple files, each containing logical sections. Place the individual files in /docs and include MKDocs mkdocs.yml file in the root directory. This file will define the docs config used for deploying documentation to Read The Docs.

Example mkdocs.yml file:

https://github.com/nautobot/nautobot-plugin-firewall-models/blob/develop/mkdocs.yml

[whitej6]

@progala & @mzbroch Please review #57 This was only changing where docs live and minor MD fixes. The content stayed the same.

[mzbroch]

DONE:

• Updates as per comments
• Moved extra attributes
• Mkdocs

TODO:

• Provide common documentation format for Models. Indicate where the models are exposed in the ** Indicate how models are named in the UI. (provide model name vs verbose/UI name mapping. UI.** mzb: I like the documentation format, but as per my knowledge it has not been a standard. For now I am not going to rewrite it unless we have a common standard for it.
• Provide stepped instructions to follow how to add a new Peering : internal and external, focus on creation-order (tracked in Documentation Improvements #58 )

[mzbroch]

@progala Please review it again. Comments have been addressed.

[mzbroch]

@progala Added the first iteration of manual on how to create bgp peerings

[progala]

I made updates to image metadata and converted some plain URLs to markdown.

Everything else looks good.