search

ibm-cloud-docs / cloud-object-storage

cloud-object-storage
15 stars 46 forks source link

Add more clarity in the documentation of legal holds #140

Closed amitpj closed 1 year ago

amitpj commented 2 years ago

Documentation page that needs to be updated: https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-immutable

Refer to discussion in following thread in the cos-cloud-forum slack channel: https://ibm-cloudplatform.slack.com/archives/C0VJSU370/p1612457138254300

Specifically, elaborate on following points:

  1. Key differences between use cases for legal hold versus retention period
  2. While describing the need for the legal hold feature, documentation says "Certain objects might need to be prevented from modification after a retention period expires". But it is not clear why legal hold is better solution than just "extend"ing the retention period or using an "indefinite" retention period.
  3. Emphasize that the fact that a legal hold can be "lifted at any time" is an important differentiator, because retention period cannot be decreased. As per the documentation: "The retention period of an object can only be extended. It cannot be decreased from the currently configured value."
  4. The documentation just says "A maximum of 100 legal holds can be applied per object". Describe the use case why more than one legal hold may be necessary on an object.