Skip to content

PRD-439: Restructure and update NetBox Assurance documentation for Enterprise launch and Cloud availability #134

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

magicalyak
Copy link
Contributor

Overview

This PR implements comprehensive updates to NetBox Assurance documentation to support the Enterprise launch and prepare for Cloud availability in early July 2025.

Key Changes

📁 Documentation Restructure

  • Broke out NetBox Assurance docs into comprehensive structure similar to NetBox Discovery
  • Created new sections: quickstart guide, workflows, and data ingestion
  • Added proper navigation hierarchy in mkdocs.yml

🏷️ Product Availability Updates

  • Updated product pills to Enterprise-only (since Enterprise is now available)
  • Added simple note about Cloud support coming early July 2025
  • Removed outdated launch messaging since Enterprise is live

📝 Content Alignment

  • Corrected terminology: use 'operational drift' instead of 'configuration drift'
  • Aligned all content with authoritative NetBox Assurance knowledge base
  • Added proper Diode SDK integration documentation
  • Included NetBox Discovery integration details
  • Updated workflows to reflect actual user journey (Data Ingestion → Analysis → Review → Action)

🛠️ Developer Resources

  • Added ai-reference directory for LLM and development resources
  • Created style guides and templates for AI-assisted documentation
  • Added comprehensive style guide with product naming conventions

New Documentation Structure

docs/netbox-assurance/
├── index.md                           # Updated main overview
├── quickstart-guide.md               # New quick start guide
├── workflows/                         # New workflow documentation
│   ├── index.md                      # Workflows overview  
│   ├── configuration.md              # Workflow configuration guide
│   ├── deviation-detection.md        # Deviation detection details
│   └── remediation.md                # Remediation workflows
├── monitoring/                        # Renamed to data ingestion
│   └── index.md                      # Data ingestion overview
└── images/                           # Screenshots and assets

Testing

  • Local mkdocs build successful
  • Navigation structure verified
  • All internal links working
  • Content accuracy reviewed against knowledge base

Related

  • Addresses PRD-439 requirements for NetBox Assurance documentation updates
  • Prepares documentation for NetBox Enterprise launch (available now)
  • Sets foundation for NetBox Cloud support (early July 2025)

Next Steps

  • Review content accuracy and completeness
  • Validate technical details with product team
  • Confirm Cloud timeline messaging

…Box Assurance docs into comprehensive structure similar to NetBox Discovery - Create new sections: quickstart guide, workflows, and data ingestion - Add ai-reference directory for LLM and development resources - Correct terminology: use 'operational drift' instead of 'configuration drift' - Update timelines: Enterprise available now, Cloud coming early July 2025 - Align content with authoritative NetBox Assurance knowledge base - Add proper Diode SDK integration documentation - Include NetBox Discovery integration details - Update product pills to Enterprise-only for current availability
…Restructured index.md to be more concise and scannable, following Discovery template - Enhanced quickstart-guide.md with step-by-step setup process and screenshots - Improved workflows/index.md with detailed 4-step process and configuration guidance - Streamlined monitoring/index.md to focus on essential data ingestion concepts - Added relevant screenshots throughout for visual guidance - Aligned all content with authoritative LLM knowledge base - Maintained Enterprise availability with Cloud timeline (July 2025)
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.

1 participant