Expand User Messages documentation in Change Logging #617

New Issue

MrUnknownDE · 2026-04-05T16:53:54+02:00

MrUnknownDE commented

2026-04-05 16:53:54 +02:00

Originally created by @mrmrcoleman on 1/11/2026

Change Type

Addition

Area

Features

Proposed Changes

The "User Messages" section in docs/features/change-logging.md currently states that users can record a message but does not explain how. This leaves users to discover the feature on their own.

Propose expanding this section to:

Explain that the "Changelog message" field appears at the bottom of object create/edit forms and delete confirmation dialogs
Note that it is optional and limited to 200 characters
Clarify it works for individual and bulk operations
Add a cross-reference to the REST API documentation for programmatic usage

Additionally, add a back-reference from the REST API "Changelog Messages" section to the change logging feature documentation.

*Originally created by @mrmrcoleman on 1/11/2026* ### Change Type Addition ### Area Features ### Proposed Changes The "User Messages" section in `docs/features/change-logging.md` currently states that users can record a message but does not explain how. This leaves users to discover the feature on their own. Propose expanding this section to: - Explain that the "Changelog message" field appears at the bottom of object create/edit forms and delete confirmation dialogs - Note that it is optional and limited to 200 characters - Clarify it works for individual and bulk operations - Add a cross-reference to the REST API documentation for programmatic usage Additionally, add a back-reference from the REST API "Changelog Messages" section to the change logging feature documentation.

MrUnknownDE closed this issue

2026-04-05 16:53:54 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium severity: medium type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#617