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

Disable search indexing for local documentation builds #6807

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

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

Originally assigned to: @jeremystretch on GitHub.

Change Type

Cleanup (formatting, typos, etc.)

Area

Other

Proposed Changes

I've noticed that when searching for NetBox documentation topics, search engines often return results pointing to the documentation hosted on our public demo instances in addition to the "correct" results on ReadTheDocs. This because the complete documentation is accessible locally on each NetBox deployment, and our public demo instance is open to the Internet.

We should be able to override the base HTML template used by mkdocs to render the documentation and inject a meta tag that instructs search engines not to index the page. However, as we obviously do want them to continue indexing ReadTheDocs, we'll need to introduce some variable to toggle this on and off.

Originally created by @jeremystretch on GitHub (Aug 12, 2022). Originally assigned to: @jeremystretch on GitHub. ### Change Type Cleanup (formatting, typos, etc.) ### Area Other ### Proposed Changes I've noticed that when searching for NetBox documentation topics, search engines often return results pointing to the documentation hosted on our public demo instances in addition to the "correct" results on ReadTheDocs. This because the complete documentation is accessible locally on each NetBox deployment, and our public demo instance is open to the Internet. We should be able to override the base HTML template used by mkdocs to render the documentation and inject a meta tag that instructs search engines not to index the page. However, as we obviously _do_ want them to continue indexing ReadTheDocs, we'll need to introduce some variable to toggle this on and off.
adam added the status: acceptedtype: documentation labels 2025-12-29 19:45:39 +01:00
adam closed this issue 2025-12-29 19:45:39 +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: 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#6807
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?