Skip to content

Clean up dochub-handled content and streamline repository #154

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

Merged
merged 3 commits into from
Jul 10, 2025

Conversation

magicalyak
Copy link
Contributor

Summary

This PR removes content that is now handled by the dochub repository and streamlines the README to clearly explain the multi-repository publishing process.

Changes Made

Content Removal

  • Removed docs/netbox-extensions/ - Branching and Diode documentation now handled by dochub
  • Removed docs/sdks/ - SDK documentation now handled by dochub
  • Clean repository structure - Focuses on console-specific documentation

README Streamlining

  • Concise documentation - Reduced from verbose to essential information
  • Multi-repository explanation - Clear pipeline: console-docs → dochub → netboxlabs.com/docs
  • Two-step publishing process - Explains the workflow for getting changes live
  • Clear contribution guidelines - Simple steps for documentation contributors
  • Essential documentation standards - Focused on required frontmatter and tags

Key Benefits

For Contributors

  • Clear workflow - Understand exactly how to contribute and publish documentation
  • Simplified structure - Repository now focused on console-specific content
  • Better guidance - README explains the relationship between repositories

For Maintainers

  • Reduced duplication - Content handled by appropriate repositories
  • Clearer responsibilities - This repo focuses on console documentation source
  • Streamlined maintenance - Less content to manage locally

Multi-Repository Integration

This change aligns with the dochub integration strategy where:

  1. console-docs (this repo) → Source documentation for console features
  2. netboxlabs-website-dochub → Integrates multiple doc repos and builds unified site
  3. netboxlabs-website → Serves final site at netboxlabs.com/docs

Contributors now follow a clear two-step process:

  1. Make changes and merge PR in this repo
  2. Update submodules and merge PR in dochub to publish live

Status: Ready for review
Breaking Changes: None - only content removal and documentation improvement

- Remove scripts/update-changes-docs.sh script that pulled netbox-changes repo
- Remove docs/netbox-extensions/changes/ directory and all synced content
- Remove Change Management navigation entries from mkdocs.yml
- Remove external documentation sync references from README.md and ai-reference/
- Remove NetBox Change Management plugin reference from docs/index.md
- Cleanup complete: dochub now handles external repository integration
@magicalyak magicalyak requested review from weyrick, mfiedorowicz and a team as code owners July 10, 2025 13:19
- Remove docs/netbox-extensions/ (branching, diode now handled by dochub)
- Remove docs/sdks/ (SDK documentation now handled by dochub)
- Update docs/index.md to reflect current repository scope
- Remove broken references to SDKs and extensions
- Add focus on Cloud Connectivity and Integrations (actual content)
- Rewrite README.md to be concise and explain:
  - Multi-repository publishing pipeline
  - Two-step process for documentation changes
  - Relationship between console-docs, dochub, and netboxlabs.com
  - Clear contribution guidelines
  - Simplified documentation standards
@magicalyak magicalyak force-pushed the cleanup-tags-sidebar-dochub-integration branch from 4b21647 to e4c0135 Compare July 10, 2025 13:23
- Add 'netbox' tag to administration console files for consistency
- Add 'netbox' tag to netbox-discovery and netbox-assurance files
- Consolidate authentication tags (remove sso, saml, okta specific tags)
- Standardize tag structure across all administration console documentation
- Align with tag standardization guidelines from alignment guide
@magicalyak
Copy link
Contributor Author

🏷️ Tag Alignment Update - Latest Commit

Just applied comprehensive tag alignment changes from console-docs-tag-fixes.diff:

Changes Applied (Commit 873e877)

  • ✅ Added netbox tag to all administration console files for consistency
  • ✅ Added netbox tag to netbox-discovery and netbox-assurance documentation
  • ✅ Consolidated authentication tags - removed specific SSO provider tags (sso, saml, okta) and standardized to authentication + configuration
  • ✅ Standardized tag structure across all documentation

Files Updated in This Commit

  • 15 Administration Console files with consistent netbox tag
  • 4 Discovery/Assurance files with enhanced tagging
  • Overall: Tag alignment applied across all relevant documentation

Alignment with Guidelines

All changes follow the recommendations from console-docs-tag-alignment-guide.md:

  • Consistent use of netbox product tag
  • Simplified authentication categorization
  • Standardized tag structure for better dochub integration

This completes the tag standardization phase and makes the repository fully ready for dochub integration with consistent, clean metadata across all documentation files.

Status: ✅ Ready for merge - all tag alignment work completed

@magicalyak magicalyak merged commit 3e1ebbc into main Jul 10, 2025
2 checks passed
@magicalyak magicalyak deleted the cleanup-tags-sidebar-dochub-integration branch July 10, 2025 14:03
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.

2 participants