Просмотр исходного кода

Add model documentation for JournalEntry

jeremystretch 3 лет назад
Родитель
Сommit
e6c69127e4
2 измененных файлов с 17 добавлено и 0 удалено
  1. 16 0
      docs/models/extras/journalentry.md
  2. 1 0
      mkdocs.yml

+ 16 - 0
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.

+ 1 - 0
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: