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

Include a notice on local documentation indicating that it's being served locally #9875

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

Originally created by @jeremystretch on GitHub (Jun 20, 2024).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

When the NetBox documentation is being rendered for local use (i.e. the BUILD_PUBLIC environment variable is not set), include a subtle indication on the rendered page indicating that the documentation is being served locally.

Justification

Currently, the documentation includes the a meta tag when BUILD_PUBLIC is not set to True:

<meta name="robots" content="noindex">

This is used to disable search indexing for NetBox deployments which have been inadvertently exposed to the Internet (see #10496). However, the presence or omission of this tag is not easily detected. Adding a human-readable indication on the rendered page makes the distinction easier and conveys to the user that the documentation may differ from the current public release.

Originally created by @jeremystretch on GitHub (Jun 20, 2024). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes When the NetBox documentation is being rendered for local use (i.e. the `BUILD_PUBLIC` environment variable is not set), include a subtle indication on the rendered page indicating that the documentation is being served locally. ### Justification Currently, the documentation includes the a meta tag when `BUILD_PUBLIC` is not set to True: ``` <meta name="robots" content="noindex"> ``` This is used to disable search indexing for NetBox deployments which have been inadvertently exposed to the Internet (see #10496). However, the presence or omission of this tag is not easily detected. Adding a human-readable indication on the rendered page makes the distinction easier and conveys to the user that the documentation may differ from the current public release.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 21:23:52 +01:00
adam closed this issue 2025-12-29 21:23:52 +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 status: accepted type: housekeeping
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#9875
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?