PRD-389: Add Comprehensive Jinja2 Templates Documentation for NetBox Enterprise #124
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@richbibby can you review this for accuracy? Also maybe we want to strip out the related links at the bottom for professionalism? |
|
a lot of the content looks solid, but I think the section 'Step-by-Step Example' needs testing and refinement. those steps don't look valid to me. I would agree with stripping out the related links at the bottom |
…e - Complete guide covering templates in configuration rendering, exports, webhooks, and custom fields - Step-by-step Cisco switch configuration example with context definition and validation - Advanced use cases including nested data access, custom fields, and environment segmentation - Testing and debugging section with local testing methods and API validation - Comprehensive FAQ addressing common customer questions and troubleshooting - Community resources and external references for further learning - Addresses Linear ticket PRD-389 and customer requests for consolidated Jinja2 guidance
magicalyak
force-pushed
the
PRD-389_Jinja2_Templates
branch
from
e76af5c to
0402fab
Compare
|
Needs more detail with location of files and hand-holding |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Comprehensive Jinja2 Templates Documentation for NetBox Enterprise
Summary
This PR adds comprehensive documentation for Jinja2 templates in NetBox Enterprise (
docs/netbox-enterprise/nbe-jinja2-templates.md), addressing customer requests for consolidated guidance on configuration automation and template usage.Problem Statement
Customers have repeatedly requested guidance on using Jinja2 templating in NetBox to automate configuration generation. Current documentation is fragmented across OSS pages, leading to:
This feature is critical for teams using NetBox to generate vendor-specific configs (Cisco, Juniper, etc.) or integrate with configuration management tools.
Solution
This documentation provides enterprise-focused guidance that consolidates fragmented information into a single, comprehensive resource.
Key Features
📚 Complete Coverage
🛠️ Practical Examples
🧪 Testing & Debugging
❓ Customer Support
Content Structure
Addresses Linear Ticket Requirements
✅ Step-by-step guide for getting started with Jinja2 templates
✅ Configuration context and data structure explanations
✅ Popular platform examples (Cisco, with references to Juniper)
✅ NetBox Enterprise workflows integration guidance
✅ Template debugging and validation instructions
✅ Community resources and external references
Referenced Issues/Discussions
Impact
This documentation will:
Testing
Files Changed:
docs/netbox-enterprise/nbe-jinja2-templates.md(new file, 547 lines)Related: