Skip to content

Deprecate repository and redirect to dochub #162

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 2 commits into from
Jul 18, 2025

Conversation

magicalyak
Copy link
Contributor

This PR marks the console-docs repository as deprecated and redirects all future documentation work to the netboxlabs-website-dochub repository.

Changes Made

  • Prominent deprecation notice at the top of README.md
  • Clear redirect instructions pointing to netboxlabs-website-dochub repository
  • Migration guide showing old vs new workflows
  • File location mapping for easy transition
  • Emphasis that changes here will NOT be published
  • Reference materials preserved but clarified they apply to new repo

Why This Change

The documentation system has been consolidated into the dochub repository where:

  • Changes are published immediately (no two-step process)
  • Better development experience with live preview
  • All NetBox documentation in one unified system
  • Direct editing in localdocs/console/ directory

Impact

  • All future documentation changes must go to netboxlabs-website-dochub
  • This repository becomes read-only for documentation purposes
  • Existing content remains as reference but won't be published
  • Team workflows need to be updated to use the new repository

This change ensures no one accidentally makes changes that won't be published and provides clear guidance for the migration.

- Add prominent deprecation notice at top of README
- Redirect all documentation changes to netboxlabs-website-dochub repository
- Provide migration guide with old vs new workflows
- Include file location mapping for easy migration
- Emphasize that changes here will NOT be published
- Keep reference materials available but clarify they apply to new repo
@magicalyak magicalyak requested review from weyrick and a team as code owners July 17, 2025 19:05
@magicalyak magicalyak merged commit 29f59ed into main Jul 18, 2025
2 checks passed
@magicalyak magicalyak deleted the deprecate-repo-redirect-to-dochub branch July 18, 2025 18:42
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