starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #10029] [MERGED] Refresh & reorganize NetBox documentation for v3.3 release #13544

New Issue
Closed
opened 2025-12-29 23:19:28 +01:00 by adam · 0 comments
adam commented 2025-12-29 23:19:28 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/10029
Author: @jeremystretch
Created: 8/16/2022
Status: ✅ Merged
Merged: 8/16/2022
Merged by: @jeremystretch

Base: feature ← Head: docs-refresh

📝 Commits (10+)

  • c582d74 Rearrange introductory content
  • 18acac1 Move data model definitions to separate hierarchy
  • b1ce8bd Started "getting started" guide
  • a6c431f Reorganize configuration docs
  • 1cd4075 Add mermaid flowcharts showing rough data model dependencies
  • a7bf7bf Merge branch 'feature' into docs-refresh
  • 5da3cab Reorganize documentation
  • 4c899f1 Drop markdown-include
  • 8c0ef1a Started on feature docs
  • 1a0b6d6 Continued work on feature docs

📊 Changes

157 files changed (+4509 additions, -1886 deletions)

View changed files

➖ docs/additional-features/webhooks.md (+0 -57)
📝 docs/administration/housekeeping.md (+2 -2)
📝 docs/administration/permissions.md (+69 -2)
➕ docs/configuration/data-validation.md (+86 -0)
➕ docs/configuration/date-time.md (+20 -0)
➕ docs/configuration/default-values.md (+77 -0)
➕ docs/configuration/development.md (+21 -0)
➖ docs/configuration/dynamic-settings.md (+0 -232)
📝 docs/configuration/index.md (+38 -12)
➕ docs/configuration/miscellaneous.md (+159 -0)
➕ docs/configuration/napalm.md (+51 -0)
➖ docs/configuration/optional-settings.md (+0 -489)
➕ docs/configuration/plugins.md (+35 -0)
📝 docs/configuration/remote-authentication.md (+16 -16)
📝 docs/configuration/required-parameters.md (+0 -0)
➕ docs/configuration/security.md (+144 -0)
➕ docs/configuration/system.md (+178 -0)
➖ docs/core-functionality/circuits.md (+0 -10)
➖ docs/core-functionality/contacts.md (+0 -5)
➖ docs/core-functionality/device-types.md (+0 -41)

...and 80 more files

📄 Description

This PR is the culmination of an effort to improve the NetBox documentation in several ways:

  • Update and extend introductory content
  • Provide a "getting started" section
  • Arrange configuration docs by topic
  • Provide a detailed documentation page for each model & expose it in the docs navigation

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/10029 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 8/16/2022 **Status:** ✅ Merged **Merged:** 8/16/2022 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `feature` ← **Head:** `docs-refresh` --- ### 📝 Commits (10+) - [`c582d74`](https://github.com/netbox-community/netbox/commit/c582d7459f2bd5db72ba407b360bf381694b1767) Rearrange introductory content - [`18acac1`](https://github.com/netbox-community/netbox/commit/18acac18e0301ad0e3355f9742177062aad403c3) Move data model definitions to separate hierarchy - [`b1ce8bd`](https://github.com/netbox-community/netbox/commit/b1ce8bd222a7b39bcacbe1d66ce5ab69f11dfe8e) Started "getting started" guide - [`a6c431f`](https://github.com/netbox-community/netbox/commit/a6c431f3ba236760ab753f92b8b7aec16c07c568) Reorganize configuration docs - [`1cd4075`](https://github.com/netbox-community/netbox/commit/1cd407548813bc959f4959f7009b3d800fe71311) Add mermaid flowcharts showing rough data model dependencies - [`a7bf7bf`](https://github.com/netbox-community/netbox/commit/a7bf7bf7a582bef900736c46eb57fa3d44146e28) Merge branch 'feature' into docs-refresh - [`5da3cab`](https://github.com/netbox-community/netbox/commit/5da3cab4de0469c8e8f19726600286abc590c7c3) Reorganize documentation - [`4c899f1`](https://github.com/netbox-community/netbox/commit/4c899f151cce9fae6ae1596c481f2fa92e6a6cf9) Drop markdown-include - [`8c0ef1a`](https://github.com/netbox-community/netbox/commit/8c0ef1a0a2e324a8b46af2591a9f1b087fcecb4d) Started on feature docs - [`1a0b6d6`](https://github.com/netbox-community/netbox/commit/1a0b6d6cb03c144caf770f9ccd02ce0970b8c37e) Continued work on feature docs ### 📊 Changes **157 files changed** (+4509 additions, -1886 deletions) <details> <summary>View changed files</summary> ➖ `docs/additional-features/webhooks.md` (+0 -57) 📝 `docs/administration/housekeeping.md` (+2 -2) 📝 `docs/administration/permissions.md` (+69 -2) ➕ `docs/configuration/data-validation.md` (+86 -0) ➕ `docs/configuration/date-time.md` (+20 -0) ➕ `docs/configuration/default-values.md` (+77 -0) ➕ `docs/configuration/development.md` (+21 -0) ➖ `docs/configuration/dynamic-settings.md` (+0 -232) 📝 `docs/configuration/index.md` (+38 -12) ➕ `docs/configuration/miscellaneous.md` (+159 -0) ➕ `docs/configuration/napalm.md` (+51 -0) ➖ `docs/configuration/optional-settings.md` (+0 -489) ➕ `docs/configuration/plugins.md` (+35 -0) 📝 `docs/configuration/remote-authentication.md` (+16 -16) 📝 `docs/configuration/required-parameters.md` (+0 -0) ➕ `docs/configuration/security.md` (+144 -0) ➕ `docs/configuration/system.md` (+178 -0) ➖ `docs/core-functionality/circuits.md` (+0 -10) ➖ `docs/core-functionality/contacts.md` (+0 -5) ➖ `docs/core-functionality/device-types.md` (+0 -41) _...and 80 more files_ </details> ### 📄 Description This PR is the culmination of an effort to improve the NetBox documentation in several ways: - Update and extend introductory content - Provide a "getting started" section - Arrange configuration docs by topic - Provide a detailed documentation page for each model & expose it in the docs navigation --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 23:19:28 +01:00
adam closed this issue 2025-12-29 23:19:28 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#13544
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?