Merge pull request #268 from dockstore/feature/SEAB-5979

SEAB-5979: Documentation for the Archive feature

docs/getting-started/archive-on-dockstore.rst

@@ -0,0 +1,71 @@
+Archiving an Entry on Dockstore
+===============================
+
+Tutorial Goals
+--------------
+
+-  Archiving an entry
+-  Unarchiving an entry
+
+This tutorial walks through the process of archiving an entry from Dockstore.
+
+This action will make your entry read-only and less prominent in the Dockstore user interface.
+You can unarchive your entry back to normal at any time.
+
+
+Specific Changes When Archived
+------------------------------
+
+After you archive the Dockstore tool, workflow, notebook, or service, it will be:
+
+- Marked as "Archived".
+- Read-only, except to unarchive. GitHub updates will be ignored.
+- Ranked lower in Dockstore Search.
+- Displayed in the "Archived" section of your Dockstore dashboard.
+
+Archiving an Entry
+------------------
+
+Navigate to ``/my-tools``, ``/my-workflows``, ``/my-notebooks``, or ``/my-services`` by going to My Dashboard then selecting the desired option in the left sidebar.
+In the sidebar accordion, find the organization that your entry is in and click the entry you would like to archive.
+
+.. image:: /assets/images/docs/sidebar-accordian-workflow-select-2.png
+   :width: 50 %
+
+You should now see your entry with the Archive button on the far right of the page. Click the Archive button.
+
+.. image:: /assets/images/docs/workflow-showing-archive-button.png
+   :width: 50 %
+
+Read the dialog message and if you are sure you would like to archive, click the Archive This <Entry> button
+
+.. image:: /assets/images/docs/archive-workflow-dialog.png
+   :width: 50 %
+
+You will now see a banner that shows that your entry is archived and read-only.
+
+.. image:: /assets/images/docs/archived-workflow-banner.png
+   :width: 50 %
+
+Unarchiving an Entry
+---------------------
+
+Navigate to ``/my-tools``, ``/my-workflows``, ``/my-notebooks``, or ``/my-services`` by going to My Dashboard then selecting the desired option in the left sidebar.
+In the sidebar accordion, find the organization that your entry is in and click the entry you would like to unarchive in the Archived section.
+
+.. image:: /assets/images/docs/sidebar-accordian-workflow-select-archived.png
+   :width: 50 %
+
+You should now see your entry with the Unarchive button on the far right of the page. Click the Unarchive button.
+
+.. image:: /assets/images/docs/archived-workflow-banner.png
+   :width: 50 %
+
+The archived banner should now be removed and your entry will function as normal.
+
+.. image:: /assets/images/docs/workflow-showing-archive-button.png
+   :width: 50 %
+
+
+.. discourse::
+    :topic_identifier: 8057

docs/getting-started/delete-on-dockstore.rst

@@ -20,7 +20,7 @@ An entry can only be deleted if it satisfies all the following:
 -  Is not a checked or checker workflow, and
 -  If registered via GitHub Apps, the entry is removed from the ``.dockstore.yml`` file or the Dockstore GitHub App is uninstalled from the source GitHub repo.
 
-If your entry does not meet the requirements above, you can archive it using these steps.
+If your entry does not meet the requirements above, you can archive it using these :doc:`steps </getting-started/archive-on-dockstore>`.
 
 Deleting an Entry
 ------------------

docs/index.rst

@@ -43,8 +43,9 @@ Getting Started
     4. :doc:`Creating a Dockstore Account <getting-started/register-on-dockstore>`
     5. :doc:`Register a tool on Dockstore <getting-started/dockstore-tools>`
     6. :doc:`Register a workflow on Dockstore <getting-started/dockstore-workflows>`
-    7. :doc:`Delete an Entry on Dockstore <getting-started/delete-on-dockstore>`
-    8. :doc:`Hosted tools and workflows <getting-started/hosted-tools-and-workflows>`
+    7. :doc:`Archive an Entry on Dockstore <getting-started/archive-on-dockstore>`
+    8. :doc:`Delete an Entry on Dockstore <getting-started/delete-on-dockstore>`
+    9. :doc:`Hosted tools and workflows <getting-started/hosted-tools-and-workflows>`
 * :doc:`Notebooks <getting-started/getting-started-with-notebooks>`
 * :doc:`Services (preview) <getting-started/getting-started-with-services>`
 * :doc:`Registering tools, workflows, notebooks, and services with the Dockstore GitHub App <getting-started/github-apps/github-apps-landing-page>`
@@ -64,6 +65,7 @@ Getting Started
    getting-started/register-on-dockstore
    getting-started/dockstore-tools
    getting-started/dockstore-workflows
+   getting-started/archive-on-dockstore
    getting-started/delete-on-dockstore
    getting-started/hosted-tools-and-workflows
    getting-started/getting-started-with-services