networktocode / ntc-netbox-plugin-onboarding

A plugin for NetBox to easily onboard new devices.
Other
246 stars 47 forks source link

Add documentation visible when viewing the on-board device form #54

Closed jedelman8 closed 4 years ago

jedelman8 commented 4 years ago

When you navigate to the form to execute a task, there is a question mark icon for help. When clicking that, there is no documentation and the following error is displayed:

Unable to load documentation, file not found: /opt/netbox/docs/models/netbox_onboarding/onboardingtask.md

We don't need much, but something describing the plugin and maybe some common questions and use cases?

dgarros commented 4 years ago

Good catch, I'm not sure if this feature is available within a plugin yet. I will follow up with the core team.

I looked at the NetBox code and I believe this is generated by these template/filter but I will confirm https://github.com/netbox-community/netbox/blob/develop/netbox/templates/utilities/obj_edit.html https://github.com/netbox-community/netbox/blob/develop/netbox/utilities/templatetags/helpers.py#L163

ryanmerolle commented 4 years ago

I thought this was a core issue hence I raised the issue: https://github.com/netbox-community/netbox/issues/4700

dgarros commented 4 years ago

Closing this one for now, the solution would be to not use a template from core netbox templates/obj_edit.html