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

Add references to Nbshell in export templates, reports and scripts #15651

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

8ctorres
Copy link

@8ctorres 8ctorres commented Apr 7, 2024

Fixes: #15014

The Netbox shell is a very powerful resource for people trying to develop their own scripts, reports or configuration templates, but I feel it is difficult to find in the documentation. For this reason, I have added a few references to it in the pages, so that a new user can find it much sooner than it took me to find.

Copy link
Member

@jeremystretch jeremystretch left a comment

Choose a reason for hiding this comment

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

Thanks @8ctorres. Let's compress some of the commentary on using nbshell to ensure we don't disrupt from the primary flow of each page.

docs/administration/netbox-shell.md Outdated Show resolved Hide resolved
docs/administration/netbox-shell.md Outdated Show resolved Hide resolved
docs/customization/custom-scripts.md Outdated Show resolved Hide resolved
docs/customization/custom-scripts.md Outdated Show resolved Hide resolved
docs/customization/export-templates.md Outdated Show resolved Hide resolved
docs/customization/reports.md Outdated Show resolved Hide resolved
docs/customization/reports.md Outdated Show resolved Hide resolved
docs/features/configuration-rendering.md Outdated Show resolved Hide resolved
@8ctorres
Copy link
Author

Hi @jeremystretch thanks for your feedback. I will try to make some changes this weekend and update the PR.

@jeremystretch
Copy link
Member

@8ctorres checking in. Are you still working on this PR?

@8ctorres
Copy link
Author

Hi @jeremystretch thanks for checking. I haven't really had the time these past few weeks, I apologize for the delay. I will try to get this done before the end of the month. Sorry again

@8ctorres
Copy link
Author

Hi @jeremystretch , sorry again for the delay with this. I have reviewed your suggestions and added another commit with a few changes. About reports, I see that they're being deprecated in v4, so maybe the documentation on that section isn't going to be so relevant anymore.

Thanks!

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.

Documentation is unclear on how to access data structures in Scripts/Reports/Config Templates/Export Templates
2 participants