[GitHub] ocket8888 commented on a change in pull request #3333: Add TO deleting old DS certs on snapshot

[GitBox <gi...@apache.org>]

ocket8888 commented on a change in pull request #3333: Add TO deleting old DS certs on snapshot
URL: https://github.com/apache/trafficcontrol/pull/3333#discussion_r260635318
 
 

 ##########
 File path: docs/source/api/cdns_id_snapshot.rst
 ##########
 @@ -25,6 +25,8 @@
 =======
 Performs a CDN snapshot. Effectively, this propagates the new *configuration* of the CDN to its *operating state*, which replaces the output of the :ref:`to-api-cdns-name-snapshot` endpoint with the output of the :ref:`to-api-cdns-name-snapshot-new` endpoint.
 
+.. Note:: Snapshotting the CRConfig also deletes all HTTPS certificates for delivery services which have been deleted since the last snapshot.
 
 Review comment:
   Please use "Snapshot" or "CDN Snapshot" as opposed to "CRConfig" (not a big deal in the TO using docs, because that whole thing is deprecated/disabled. Frankly I wouldn't care if you didn't update it). It's probably less awkward to refer to the action as "taking a CDN Snapshot" rather than "Snapshotting the CDN Snapshot".
   
   Also, "Snapshot" and "Delivery Service" are ATC *terms* and should be linked to the glossary. At a minimum that should be done once per major section ("page" in an HTML context) but ideally it'd be all of them. Regardless of whether you decide to link them here - assuming it is done elsewhere in the same major section - they should be capitalized like that for ease of recognition.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services