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

Provide Markdown help with links to local documentation pages #6565

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

Originally created by @jcralbino on GitHub (Jun 15, 2022).

Originally assigned to: @kkthxbye-code on GitHub.

NetBox version

v3.2.4

Feature type

New functionality

Proposed functionality

Currently netbox supports a documentation package as part of the main release due to https://github.com/netbox-community/netbox/issues/6328

I propose to change the Markdown assistance available in some text areas ( for example in comments fields) that is currently going to "https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet" to another URL as part of the offline documentation package
image

I propose that a new section in the documentation package is created, based in the github url above, and use the corresponding link within this assistance fields.

The final url could be something like, if this section is placed under references.
https://netboxfqdn/static/docs/reference/markdown/

Use case

The following use cases are applicable:

Provide the correct documentation that is always related to the specific version being used, instead of the online version that refers the latest version.
Provide access to the documentation to system installed in a isolated management environment that do not have internet access.

Database changes

none

External dependencies

none

Originally created by @jcralbino on GitHub (Jun 15, 2022). Originally assigned to: @kkthxbye-code on GitHub. ### NetBox version v3.2.4 ### Feature type New functionality ### Proposed functionality Currently netbox supports a documentation package as part of the main release due to https://github.com/netbox-community/netbox/issues/6328 I propose to change the Markdown assistance available in some text areas ( for example in comments fields) that is currently going to "https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet" to another URL as part of the offline documentation package ![image](https://user-images.githubusercontent.com/44149262/173758856-79739e48-1eb3-4173-9b09-9908fa1c92df.png) I propose that a new section in the documentation package is created, based in the github url above, and use the corresponding link within this assistance fields. The final url could be something like, if this section is placed under references. https://netboxfqdn/static/docs/reference/markdown/ ### Use case The following use cases are applicable: Provide the correct documentation that is always related to the specific version being used, instead of the online version that refers the latest version. Provide access to the documentation to system installed in a isolated management environment that do not have internet access. ### Database changes none ### External dependencies none
adam added the status: acceptedtype: feature labels 2025-12-29 19:42:27 +01:00
adam closed this issue 2025-12-29 19:42:28 +01:00
adam commented 2025-12-29 19:42:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 15, 2022):

Thanks for capturing this. There's a TODO line in the code for this that's been around for ~5 years that just never made it into an issue. 😆

@jeremystretch commented on GitHub (Jun 15, 2022): Thanks for capturing this. There's a `TODO` line in the code for this that's been around for ~5 years that just never made it into an issue. :laughing:
adam commented 2025-12-29 19:42:28 +01:00
Author
Owner
Copy Link

@jcralbino commented on GitHub (Jun 16, 2022):

No problem. I have also identified this at some point but never went trough to this process of creating the ticket

I guess this week when i faced the issue again of needing access to internet just for the reference to I realised that this can be incorporated in local docs packaging

Cheers
José

@jcralbino commented on GitHub (Jun 16, 2022): No problem. I have also identified this at some point but never went trough to this process of creating the ticket I guess this week when i faced the issue again of needing access to internet just for the reference to I realised that this can be incorporated in local docs packaging Cheers José
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 status: accepted type: feature
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#6565
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?