Updated docs for custom comment addition

CHANGELOG.md

@@ -4,6 +4,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Option to tag a published content view with a custom comment
+
 ### Fixed
 - Fix unreferenced var in check_disk_space function
 - Various minor README corrections

README.md

@@ -401,7 +401,13 @@ Publishes new content to the Library environment. The following can be published
   - All content views (-a)
 
 The dry run (-d) option can be used to see what would be published for a
-given command input.
+given command input. By default progress bars will be displayed for each content
+view being published. It may be desirable to not display these (e.g. automating), so
+they can be disabled using the (-q) option.
+
+A default comment will be added to the published content view version containing the
+username of the user that initiated the publish. Alternatively, a custom comment 
+can be added to the published view using the (-c) option.
 
 Each time a content view is published or promoted, a datestamp is recorded so that
 the last publish/promote date can be viewed with the (-l) option. Note that this
@@ -424,7 +430,7 @@ once, to aid in performance tuning.
 
 
 ```
-usage: publish_content_view.py [-h] [-o ORG] [-a] [-d]
+usage: publish_content_view.py [-h] [-o ORG] [-a] [-d] [-c COMMENT] [-q]
 
 Publishes content views for specified organization.
 
@@ -434,6 +440,8 @@ optional arguments:
   -a, --all          Publish ALL content views
   -d, --dryrun       Dry Run - Only show what will be published
   -l, --last         Display last promotions
+  -c, --comment      Add a custom description
+  -q, --quiet        Suppress progress output updates
 ```
 
 ### Examples
@@ -455,7 +463,9 @@ The following can be promoted:
   - All content views (-a)
 
 The dry run (-d) option can be used to see what would be promoted for a
-given command input.
+given command input. By default progress bars will be displayed for each content
+view being promoted. It may be desirable to not display these (e.g. automating), so
+they can be disabled using the (-q) option.
 
 Each time a content view is published or promoted, a datestamp is recorded so that
 the last publish/promote date can be viewed with the (-l) option. Note that this
@@ -486,7 +496,7 @@ The batch: parameter can be used to limit the number of content views that will
 once, to aid in performance tuning.
 
 ```
-usage: promote_content_view.py [-h] -e ENV [-o ORG] [-a] [-d]
+usage: promote_content_view.py [-h] -e ENV [-o ORG] [-a] [-d] [-q]
 
 Promotes content views for specified organization to the target environment.
 
@@ -498,6 +508,7 @@ optional arguments:
   -a, --all          Promote ALL content views
   -d, --dryrun       Dry Run - Only show what will be promoted
   -l, --last         Display last promotions
+  -q, --quiet        Suppress progress output updates
 ```
 
 ### Examples

man/publish_content_views.8

@@ -47,6 +47,13 @@ Do not perform the actual publish activity, but show what would be done.
 This option can be used to verify that the correct configuration options have been defined and applied before running the actual publication of content.
 .RE
 .PP
+.BR "-c", " --comment"
+.I "COMMENT"
+.RS 3
+Tag the published content view with a custom comment.
+By default a comment indicating the content view was published via the API by the user running the script is used.
+.RE
+.PP
 .BR "-q", " --quiet"
 .RS 3
 Do not display refreshing progress bars during the operation.