Changelog and documentation for #151

netbox-community · Mar 17, 2021 · bd95d2b · bd95d2b
1 parent 956e272
commit bd95d2b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/models/extras/journalentry.md b/docs/models/extras/journalentry.md
@@ -0,0 +1,5 @@
+# Journal Entries
+
+All primary objects in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintained for historical context. It supplements NetBox's change log to provide additional information about why changes have been made or to convey events which occur outside of NetBox. Unlike the change log, which is typically limited in the amount of history it retains, journal entries never expire.
+
+Each journal entry has a user-populated `commnets` field. Each entry records the date and time, associated user, and object automatically upon being created.
diff --git a/docs/release-notes/version-2.11.md b/docs/release-notes/version-2.11.md
@@ -9,6 +9,10 @@ later will be required.
 
 ### New Features
 
+#### Journaling Support ([#151](https://github.com/netbox-community/netbox/issues/151))
+
+NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for historical context. It supplements NetBox's change log to provide additional information about why changes have been made or to convey events which occur outside of NetBox. Unlike the change log, which is typically limited in the amount of history it retains, journal entries never expire.
+
 #### Parent Interface Assignments ([#1519](https://github.com/netbox-community/netbox/issues/1519))
 
 Virtual interfaces can now be assigned to a "parent" physical interface, by setting the `parent` field on the Interface model. This is helpful for associating subinterfaces with their physical counterpart. For example, you might assign virtual interfaces Gi0/0.100 and Gi0/0.200 to the physical interface Gi0/0.