Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jeremystretch opened this issue Jun 20, 2024 · 0 comments · Fixed by #17520
Closed
Assignees
Labels
status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user

Comments

@jeremystretch
Copy link
Member

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.

@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user labels Jun 20, 2024
@jeremystretch jeremystretch self-assigned this Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant