SEAB-6957: Documentation for delete entry feature #264
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| Deleting an Entry on Dockstore | ||
| =================================== | ||
|
|
||
| Tutorial Goals | ||
| -------------- | ||
|
|
||
| - Deleting an entry | ||
| - Ensuring that the entry does not re-appear on Dockstore | ||
|
|
||
| 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. | ||
hyunnaye marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Requirements for Deletion | ||
| ------------------------- | ||
|
|
||
| An entry can only be deleted if it satisfies all the following: | ||
hyunnaye marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - Has never been published, | ||
| - Was created on/after April 1, 2022, | ||
| - 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. | ||
|
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 |
||
|
|
||
| Deleting 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 GitHub repository that your entry is in and click the entry you would like to delete. | ||
|
|
||
| .. image:: /assets/images/docs/sidebar-accordian-workflow-select.png | ||
| :width: 50 % | ||
|
|
||
| You should now see your entry with the Delete button on the far right of the page. Click the Delete button. | ||
|
|
||
| .. image:: /assets/images/docs/workflow-showing-delete-button.png | ||
| :width: 50 % | ||
|
|
||
| Read the dialog message and if you are sure you would like to delete, click the Delete this workflow/tool/notebook/service button | ||
|
|
||
| .. image:: /assets/images/docs/delete-workflow-dialog.png | ||
| :width: 50 % | ||
|
|
||
| Please make sure that you have uninstalled the Dockstore GitHub App from the source GitHub repo, or edited/removed the ``.dockstore.yml`` file so that it no longer describes the deleted entry. | ||
| If you do not, your deleted entry may reappear on Dockstore the next time you push to the repo. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kept line to keep consistent with dialog