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

Clarify TIME_ZONE documentation - what does "dealing with" mean? #8498

New Issue
Closed
opened 2025-12-29 20:37:28 +01:00 by adam · 2 comments
adam commented 2025-12-29 20:37:28 +01:00
Owner
Copy Link

Originally created by @pv2b on GitHub (Aug 23, 2023).

Change Type

Correction

Area

Configuration

Proposed Changes

The current documentation for the TIME_ZONE configuration parameter reads:

TIME_ZONE

Default: UTC

The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the list of available time zones.

Let's go focus on this sentence:

The time zone NetBox will use when dealing with dates and times.

This is far too vague. "Dealing with" can imply a lot of things, including when date/times are communicated through the API, or bulk imports, configuration generation, etc. But as far as I can tell, Netbox doesn't really do anything with TIME_ZONE other than pass it on to Django, which, as far as I can tell, only uses it for display formatting. If it does anything else though, that's probably be need to be in the documentation.

My proposal is to change the documentation to:

The time zone NetBox will use when displaying with dates and times in the web interface.

And if it in fact does more, it would be best clarified.

Originally created by @pv2b on GitHub (Aug 23, 2023). ### Change Type Correction ### Area Configuration ### Proposed Changes The [current documentation](https://demo.netbox.dev/static/docs/configuration/optional-settings/#time_zone) for the `TIME_ZONE` configuration parameter reads: > TIME_ZONE > > Default: UTC > > The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the [list of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Let's go focus on this sentence: > The time zone NetBox will use when dealing with dates and times. This is far too vague. "Dealing with" can imply a lot of things, including when date/times are communicated through the API, or bulk imports, configuration generation, etc. But as far as I can tell, Netbox doesn't really do anything with TIME_ZONE other than pass it on to Django, which, as far as I can tell, only uses it for display formatting. If it does anything else though, that's probably be need to be in the documentation. My proposal is to change the documentation to: > The time zone NetBox will use when displaying with dates and times in the web interface. And if it in fact does more, it would be best clarified.
adam added the type: documentationpending closure labels 2025-12-29 20:37:28 +01:00
adam closed this issue 2025-12-29 20:37:28 +01:00
adam commented 2025-12-29 20:37:29 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Nov 22, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 22, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:37:29 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 22, 2023):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Dec 22, 2023): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure 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#8498
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?