diff --git a/docs/models/extras/journalentry.md b/docs/models/extras/journalentry.md new file mode 100644 index 000000000..7e9bc986d --- /dev/null +++ b/docs/models/extras/journalentry.md @@ -0,0 +1,16 @@ +# Journal Entries + +Most objects in NetBox support journaling. This is the ability of users to record chronological notes indicating changes to or work performed on resources in NetBox. For example, a data center technician might add a journal entry for a device when swapping out a failed power supply. + +## Fields + +### Kind + +A general classification for the entry type (info, success, warning, or danger.) + +!!! tip + Additional kinds may be defined by setting `JournalEntry.kind` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Comments + +The body of the journal entry. [Markdown](../../reference/markdown.md) rendering is supported. diff --git a/mkdocs.yml b/mkdocs.yml index be9c31651..eef000481 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -196,6 +196,7 @@ nav: - CustomLink: 'models/extras/customlink.md' - ExportTemplate: 'models/extras/exporttemplate.md' - ImageAttachment: 'models/extras/imageattachment.md' + - JournalEntry: 'models/extras/journalentry.md' - Tag: 'models/extras/tag.md' - Webhook: 'models/extras/webhook.md' - IPAM: