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

Add a "best practices" guide for common modeling questions #6883

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

Originally created by @jeremystretch on GitHub (Aug 26, 2022).

Change Type

Addition

Area

Other

Proposed Changes

Add a new section to the NetBox documentation to provide guidance on how best to model common scenarios. Example include:

  • Determining when a custom field or plugin is appropriate
  • VLANs which span an arbitrary domain
  • How to handle dual-mode (multiple media) interfaces

Ideally, we should expand this content every time a similar question is raised by a user.

Originally created by @jeremystretch on GitHub (Aug 26, 2022). ### Change Type Addition ### Area Other ### Proposed Changes Add a new section to the NetBox documentation to provide guidance on how best to model common scenarios. Example include: * Determining when a custom field or plugin is appropriate * VLANs which span an arbitrary domain * How to handle dual-mode (multiple media) interfaces Ideally, we should expand this content every time a similar question is raised by a user.
adam added the type: documentationstatus: needs ownerpending closure labels 2025-12-29 19:46:19 +01:00
adam closed this issue 2025-12-29 19:46:19 +01:00
adam commented 2025-12-29 19:46:20 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Aug 26, 2022):

I know it isn't strictly related to code/docs, but we may want to add a "How do I do x" tag for discussions so we can more easily locate the types of questions too.

@DanSheps commented on GitHub (Aug 26, 2022): I know it isn't strictly related to code/docs, but we may want to add a "How do I do x" tag for discussions so we can more easily locate the types of questions too.
adam commented 2025-12-29 19:46:20 +01:00
Author
Owner
Copy Link

@arcticash commented on GitHub (Sep 1, 2022):

Would definitely like this to become a feature, quite a few times I've wondered if I'm configuring things following best practice when setting up a new instance of NetBox.

@arcticash commented on GitHub (Sep 1, 2022): Would definitely like this to become a feature, quite a few times I've wondered if I'm configuring things following best practice when setting up a new instance of NetBox.
adam commented 2025-12-29 19:46:20 +01:00
Author
Owner
Copy Link

@eronlloyd commented on GitHub (Sep 11, 2022):

I will help with this effort. I'm currently working on a best practices blog post for modeling optical devices now that #9102 has been resolved, but will start a list of other common cases.

@eronlloyd commented on GitHub (Sep 11, 2022): I will help with this effort. I'm currently working on a best practices blog post for modeling optical devices now that #9102 has been resolved, but will start a list of other common cases.
adam commented 2025-12-29 19:46:20 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Nov 11, 2022):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 11, 2022): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 19:46:20 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 12, 2022):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Dec 12, 2022): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure status: needs owner type: documentation
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#6883
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?