new-post: introducing the prune command in REANA client #35
Conversation
| The management of disk space in REANA can be a challenge, especially when the workspace is | ||
| cluttered by numerous temporary files that are no longer needed. | ||
| If you have been looking for a way to easily free up disk space in your workspaces, | ||
| look no further than the new `prune` command in `reana-client`! | ||
|
|
||
| With the `prune` command, you can easily delete all the files from your workspace that are | ||
| neither input nor output files. This can free up a significant amount of disk space and make | ||
| your workspace much more manageable. Plus, if you need to free up even more space, you can use the | ||
| `--include-inputs` and `--include-outputs` flags to delete those kinds of files too. |
There was a problem hiding this comment.
This is a personal opinion, so feel free to disagree. I think there are quite some repetitions, in particular in the first few paragraphs. I am referring to expressions like ... free up disk space ..., ... neither inputs nor outputs ..., but also that for example --include-inputs and --include-outputs are explained twice, here and in the next paragraph.
Reading the blog post I have the feeling that the important bits are only after So how do you use the prune command?, while the previous paragraphs repeat many times the same couple of "bullet points" (i.e. that prune helps to free disk space by deleting files from the workspace).
Instead of these two paragraphs, I would personally start by showing how you could save space now with the rm command, highlighting why it can be challenging/burdensome to free up disk space while also keeping the I/O files, as you need to delete files manually. Describing a common scenario which is improved by a new feature is something we do in many blog posts, to show users how new features can help them (some examples: kerberos, reana-client AppImage, launcher). The description of reana-client prune would then follow.
There was a problem hiding this comment.
Okay, I see your point and I like the suggestion. I tried to rewrite the first paragraphs, so that they are just an introduction and include this common scenario. What do you think?
There was a problem hiding this comment.
I would simplify the text a bit more, and especially add a warning that people should properly populate their outputs clause of reana.yaml specification file, otherwise the prune command may remove "too much"! I saw many people don't bother populating "outputs" because it does not really have had any impact besides ease of downloading many files. So we should really underline this here.
| your workspace much more manageable. Plus, if you need to free up even more space, you can use the | ||
| `--include-inputs` and `--include-outputs` flags to delete those kinds of files too. | ||
|
|
||
| So how do you use the `prune` command? It's easy! Just run `reana-client prune -w <workflow_name>` to |
There was a problem hiding this comment.
I would personally put reana-client prune -w <workflow_name> in a "full" code block, instead of simply inlining it with the rest of the text, as it becomes easier to spot in the blog post. We could even add its output. I would also use something like my-analysis.42 instead of <workflow_name>. What do you think?
| date: 2023-04-24T07:00:00+01:00 | ||
| --- | ||
|
|
||
| The new prune command in the reana-client software allows users to easily |
There was a problem hiding this comment.
We should use reana-client instead of reana-client when referring to the command line executable. In the same way, we should use prune instead of prune when referring to the CLI command.
|
|
||
| So how do you use the `prune` command? It's easy! Just run `reana-client prune -w <workflow_name>` to | ||
| delete all the files from the workspace of the specified workflow that are neither input nor output files. | ||
| If you want to include input or output files in the deletion process, |
There was a problem hiding this comment.
| If you want to include input or output files in the deletion process, | |
| If you also want to delete input or output files, |
What do you think?
| before running the command. Additionally, be careful when using the `--include-inputs` or | ||
| `--include-outputs` flags, as deleting input or output files could impact the results of your workflow. |
There was a problem hiding this comment.
| before running the command. Additionally, be careful when using the `--include-inputs` or | |
| `--include-outputs` flags, as deleting input or output files could impact the results of your workflow. | |
| before running the command. Additionally, be careful when using the `--include-inputs` or | |
| `--include-outputs` flags, as deleting inputs will make it impossible to run your workflow again and by deleting output files you will lose the results of your workflow run. |
What do you think of describing what happens more precisely, instead of a more generic could impact the results of your wofklow?
| before running the command. Additionally, be careful when using the `--include-inputs` or | ||
| `--include-outputs` flags, as deleting input or output files could impact the results of your workflow. | ||
|
|
||
| The prune command is available in REANA starting from version 0.9.1. |
There was a problem hiding this comment.
As we do in other blog posts, I would use the future tense (will be available ...), while also saying that this feature is already present on reana.cern.ch. What do you think?
| from your workspace. This means that you should make sure you have backed up any files you want to keep | ||
| before running the command. Additionally, be careful when using the `--include-inputs` or | ||
| `--include-outputs` flags, as deleting input or output files could impact the results of your workflow. | ||
|
|
There was a problem hiding this comment.
What do you think about also adding a brief paragraph explaining that users can achieve the same thing in a more automatic way by using retention rules, and linking to the related blog post?
giuseppe-steduto
force-pushed
the
add-prune-command-post
branch
from
72c58f7
to
87c92a6
Compare
giuseppe-steduto
force-pushed
the
add-prune-command-post
branch
from
87c92a6
to
1eed40a
Compare
No description provided.