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 #4333] [MERGED] Closes #4217: Implement contextual documentation for models #12816

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

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/4333
Author: @jeremystretch
Created: 3/9/2020
Status: ✅ Merged
Merged: 3/9/2020
Merged by: @jeremystretch

Base: develop ← Head: 4217-contextual-docs

📝 Commits (10+)

📊 Changes

120 files changed (+1111 additions, -1535 deletions)

View changed files

📝 base_requirements.txt (+0 -4)
📝 docs/additional-features/context-data.md (+2 -4)
📝 docs/additional-features/tags.md (+2 -23)
📝 docs/administration/netbox-shell.md (+2 -0)
📝 docs/administration/replicating-netbox.md (+9 -7)
📝 docs/api/authentication.md (+4 -2)
📝 docs/api/examples.md (+6 -6)
📝 docs/api/overview.md (+12 -10)
📝 docs/api/working-with-secrets.md (+5 -3)
📝 docs/configuration/index.md (+2 -0)
📝 docs/configuration/optional-settings.md (+8 -0)
📝 docs/core-functionality/circuits.md (+5 -30)
➕ docs/core-functionality/device-types.md (+40 -0)
📝 docs/core-functionality/devices.md (+15 -140)
📝 docs/core-functionality/ipam.md (+6 -83)
📝 docs/core-functionality/power.md (+5 -25)
📝 docs/core-functionality/secrets.md (+3 -50)
📝 docs/core-functionality/services.md (+2 -4)
📝 docs/core-functionality/sites-and-racks.md (+7 -47)
📝 docs/core-functionality/tenancy.md (+3 -19)

...and 80 more files

📄 Description

Closes: #4217

  • Reorganize documentation into separate files for each model
  • Drop py-gfm and upgrade Markdown
  • Refactor documentation hierarchy and headings
  • Ditch v1.x release notes
  • Add pop-up modals for embedded model documentation

🔄 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/4333 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 3/9/2020 **Status:** ✅ Merged **Merged:** 3/9/2020 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `4217-contextual-docs` --- ### 📝 Commits (10+) - [`7039746`](https://github.com/netbox-community/netbox/commit/70397461eba6a44b5a2d7b33c9a25c7e8297badb) Enable support for Markdown inclusions - [`b2bc1bf`](https://github.com/netbox-community/netbox/commit/b2bc1bf74ab728d0a415576a97c967957fa80f9d) Refactor circuits docs - [`92949dd`](https://github.com/netbox-community/netbox/commit/92949ddcdb8d380c2cc999196afc11ac6a0d96b7) Refactor device docs - [`6ba24c3`](https://github.com/netbox-community/netbox/commit/6ba24c32968bc92544ae87310eeec5c82a8ce189) Refactor site/rack docs - [`a320b54`](https://github.com/netbox-community/netbox/commit/a320b54c2f57228ffea82e37a7c94d1979bb1556) Refactor power docs - [`5933747`](https://github.com/netbox-community/netbox/commit/593374764dbb7c5e4d385da29d223414ff966325) Refactor IPAM docs - [`7793f28`](https://github.com/netbox-community/netbox/commit/7793f281c522982ecb575366e87f523dc4dda24c) Refactor secrets docs - [`a061a03`](https://github.com/netbox-community/netbox/commit/a061a038603b56bb47e1e6abc8c6182a1812ba48) Refactor service docs - [`b8b02c7`](https://github.com/netbox-community/netbox/commit/b8b02c7b25044d671232772eccaced1910f0077d) Refactor tenancy docs - [`f9c9cf9`](https://github.com/netbox-community/netbox/commit/f9c9cf9ad2b3e21fdd7bb99d1b4c11ae9366d595) Refactor virtualization docs ### 📊 Changes **120 files changed** (+1111 additions, -1535 deletions) <details> <summary>View changed files</summary> 📝 `base_requirements.txt` (+0 -4) 📝 `docs/additional-features/context-data.md` (+2 -4) 📝 `docs/additional-features/tags.md` (+2 -23) 📝 `docs/administration/netbox-shell.md` (+2 -0) 📝 `docs/administration/replicating-netbox.md` (+9 -7) 📝 `docs/api/authentication.md` (+4 -2) 📝 `docs/api/examples.md` (+6 -6) 📝 `docs/api/overview.md` (+12 -10) 📝 `docs/api/working-with-secrets.md` (+5 -3) 📝 `docs/configuration/index.md` (+2 -0) 📝 `docs/configuration/optional-settings.md` (+8 -0) 📝 `docs/core-functionality/circuits.md` (+5 -30) ➕ `docs/core-functionality/device-types.md` (+40 -0) 📝 `docs/core-functionality/devices.md` (+15 -140) 📝 `docs/core-functionality/ipam.md` (+6 -83) 📝 `docs/core-functionality/power.md` (+5 -25) 📝 `docs/core-functionality/secrets.md` (+3 -50) 📝 `docs/core-functionality/services.md` (+2 -4) 📝 `docs/core-functionality/sites-and-racks.md` (+7 -47) 📝 `docs/core-functionality/tenancy.md` (+3 -19) _...and 80 more files_ </details> ### 📄 Description ### Closes: #4217 - Reorganize documentation into separate files for each model - Drop py-gfm and upgrade Markdown - Refactor documentation hierarchy and headings - Ditch v1.x release notes - Add pop-up modals for embedded model documentation --- <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 22:23:47 +01:00
adam closed this issue 2025-12-29 22:23:48 +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#12816
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?