Merge branch '15572-new-install-docs' refs #15572
[arvados.git] / doc / user / tutorials / tutorial-keep-collection-lifecycle.html.textile.liquid
index ad8ce1e4792d6a49edd415eaf82d289e81deef72..2375e8b3d5bb53f243d0877c6bd2bb8a7280467a 100644 (file)
@@ -3,8 +3,13 @@ layout: default
 navsection: userguide
 title: "Keep collection lifecycle"
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
-During it's lifetime, a keep collection can be in various states. These states are "persisted", "expiring", "trashed"  and "permanently deleted".
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+During it's lifetime, a keep collection can be in various states. These states are *persisted*, *expiring*, *trashed*  and *permanently deleted*.
 
 A collection is *expiring* when it has a *trash_at* time in the future. An expiring collection can be accessed as normal, but is scheduled to be trashed automatically at the *trash_at* time.
 
@@ -21,8 +26,8 @@ h2(#collection_attributes). Collection lifecycle attributes
 As listed above the attributes that are used to manage a collection lifecycle are it's *is_trashed*, *trash_at*, and *delete_at*. The table below lists the values of these attributes and how they influence the state of a collection and it's accessibility.
 
 table(table table-bordered table-condensed).
-|_. collection state|_. is_trashed|_. trash_at|_. delete_at|_. get|_. index|_. index?include_trash=true|_. can be modified|
-|normal collection|false |null |null |yes |yes |yes |yes |
+|_. collection state|_. is_trashed|_. trash_at|_. delete_at|_. get|_. list|_. list?include_trash=true|_. can be modified|
+|persisted collection|false |null |null |yes |yes |yes |yes |
 |expiring collection|false |future |future |yes  |yes |yes |yes |
 |trashed collection|true |past |future |no |no |yes |only is_trashed, trash_at and delete_at attribtues|
 |deleted collection|true|past |past |no |no |no |no |
@@ -47,10 +52,10 @@ A collection can be un-trashed / recovered using either the arv command line too
 
 h3. Un-trashing a collection using arv command line tool
 
-You can list the trashed collections using the index command.
+You can list the trashed collections using the list command.
 
 <pre>
-arv collection index --include-trash=true --filters '[["is_trashed", "=", "true"]]'
+arv collection list --include-trash=true --filters '[["is_trashed", "=", "true"]]'
 </pre>
 
 You can then untrash a particular collection using arv using it's uuid.