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

Incorrect image link in docs/models/dcim/cable.md #5616

New Issue
Closed
opened 2025-12-29 19:30:10 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:30:10 +01:00
Owner
Copy Link

Originally created by @candlerb on GitHub (Nov 4, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0.9

Python version

3.8

Steps to Reproduce

  1. Install v3.0.9 (and observe output of ./upgrade.sh)
  2. Navigate to /static/docs/models/dcim/cable/
    • Manual way: click the Docs link, Development, Models, dcim.Cable

Expected Behavior

Valid links

Observed Behavior

upgrade.sh gives the following warning:

WARNING  -  Documentation file 'models/dcim/cable.md' contains a link to 'models/media/models/dcim_cable_trace.png' which is not found in the documentation files.

The page /static/docs/models/dcim/cable/ shows the broken link:

image

I believe an extra ../ is required in the relative image URL.

Originally created by @candlerb on GitHub (Nov 4, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0.9 ### Python version 3.8 ### Steps to Reproduce 1. Install v3.0.9 (and observe output of `./upgrade.sh`) 2. Navigate to `/static/docs/models/dcim/cable/` * Manual way: click the Docs link, Development, Models, dcim.Cable ### Expected Behavior Valid links ### Observed Behavior upgrade.sh gives the following warning: ``` WARNING - Documentation file 'models/dcim/cable.md' contains a link to 'models/media/models/dcim_cable_trace.png' which is not found in the documentation files. ``` The page `/static/docs/models/dcim/cable/` shows the broken link: ![image](https://user-images.githubusercontent.com/44789/140415494-e114ad14-a355-4111-a7c9-37921e78dec5.png) I believe an extra `../` is required in the relative image URL.
adam added the type: bugstatus: accepted labels 2025-12-29 19:30:10 +01:00
adam closed this issue 2025-12-29 19:30:10 +01:00
adam commented 2025-12-29 19:30:11 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Nov 5, 2021):

Unfortunately there's a limitation with the markdown-include extension when included files reference embedded images. In order for the image to load properly at /docs/core-functionality/devices/, the path must be set to its current value. I've not identified a way to have it load on both pages reliably.

I think I'll just move the image to the core functionality page to avoid the issue.

@jeremystretch commented on GitHub (Nov 5, 2021): Unfortunately there's a limitation with the [markdown-include](https://github.com/cmacmackin/markdown-include) extension when included files reference embedded images. In order for the image to load properly at `/docs/core-functionality/devices/`, the path must be set to its current value. I've not identified a way to have it load on both pages reliably. I think I'll just move the image to the core functionality page to avoid the issue.
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: bug
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#5616
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?