SEAB-6957: Documentation for delete entry feature #264
Conversation
| .. image:: /assets/images/docs/delete-notebook-dialog.png | ||
| :width: 50 % | ||
|
|
||
| After you delete the entry, you must uninstall the Dockstore GitHub App from the source GitHub repo, or edit/remove the .dockstore.yml file so that it no longer describes the deleted entry. |
There was a problem hiding this comment.
Seems like this tutorial is for deleting GitHub App entries because this step isn't applicable to legacy/hosted tools and workflows. Maybe we should move it to the Dockstore GitHub App section to avoid possible confusion? https://docs.dockstore.org/en/stable/getting-started/github-apps/github-apps-landing-page.html
There was a problem hiding this comment.
Think this is worth it's own article, could also add this to the list of requirements about though
| - Uninstalling the Dockstore GitHub App from the source GitHub repo | ||
|
|
||
| This tutorial walks through the process of deleting entries from Dockstore. | ||
| This action is permanent and after you delete the workflow, it will no longer appear on Dockstore. |
There was a problem hiding this comment.
Nit: You're following the dialog text, where I should have noticed it earlier, but it seems little dissonant to on the one hand say it's permanent and will no longer appear on Dockstore, and then there is a section below on how to ensure is doesn't appear again -- that's not permanent. :)
Not sure I have an easy rephrasing in mind, so just something to ponder, and if no other idea comes, ok to leave.
There was a problem hiding this comment.
Kept line to keep consistent with dialog
| - Was created on/after April 1, 2022, and | ||
| - Is not a checked or checker workflow. | ||
|
|
||
| If your entry does not meet the requirements above, you can archive it using these steps. |
There was a problem hiding this comment.
I'll link the documentation page for archiving in my next PR for https://ucsc-cgl.atlassian.net/browse/SEAB-5979
Description
This PR creates a new documentation page with the steps to delete an entry.
Issue
https://ucsc-cgl.atlassian.net/browse/SEAB-6057
Please make sure that you've checked the following before submitting your pull request. Thanks!