Skip to content

Provide Markdown help with links to local documentation pages #9533

@jcralbino

Description

@jcralbino

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 #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

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions