Improve Files Backdrop stage of process - or improve help text

stpaultim commented 3 months ago

I've never gotten this part of the process to work and Irina usually skips over this step during her demonstrates and follows the suggested process of manually moving the files.

I'm curious, does this step work for anyone?

If not, should we disable it until it does?

At a minimum, I would like to reorganize the text to better emphasize the recommended process for moving the files.

I am working on a PR now.

stpaultim commented 3 months ago

I created a PR. Here is what the changes look like. I welcome suggestions or corrections.

Was:

PR Suggests:

stpaultim commented 3 months ago

@irinaz and @docwilmot

stpaultim commented 3 months ago

@irinaz - I take it you mean it will take some time to improve how this works.

What about the text change I am suggesting as a temporary measure?

irinaz commented 3 months ago

@stpaultim , I deleted my comment that was not thought through. I love big bold text that says "move files manually". thank you!!

yorkshire-pudding commented 3 months ago

Definitely makes sense to make the text clearer.

stpaultim commented 3 months ago

Definitely makes sense to make the text clearer.

@yorkshire-pudding Thanks for feedback. Is the suggested text "clearer" and/or do you have ideas to make it better?

yorkshire-pudding commented 3 months ago

Definitely makes sense to make the text clearer.

@yorkshire-pudding Thanks for feedback. Is the suggested text "clearer" and/or do you have ideas to make it better?

Sorry, my reply should have been clearer. Yes I think your PR makes the text much clearer. Thanks

klonos commented 3 months ago

Here are my thoughts:

We are clearly at a step of the process that provides two options. One is the recommended way, the other one not recommended but still offered. To me that translates to adding two radio buttons in the form: one to say "I will copy the files manually" (or "I have already copied the files manually"), and the other "Automatically copy the files for me (unreliable - not recommended)".

The "Source site URL" field should really be "URL of the source site" or better yet "URL of the Drupal 7 site" really, in which case the help text for it then would not be required and could be removed.

The "Source site URL" field and the "Copy files" button should both be hidden via #states and only shown if the user selects the risky option. A warning should be shown instead of the plain-text "please use this with caution" if the risky option is shown.

...I might put that together as an alternative PR for people to test, and so that I can provide some screenshots here.

stpaultim commented 3 months ago

@klonos I think your idea is excellent.

But, in case your PR does not come along quickly, I hope we can get this needed change to the help text committed and then make it better later.

klonos commented 3 months ago

OK, this is what I currently have on my local:

Skip copying files (the default when the form for this step is loaded):
Select the option to copy files automatically:

Text used:

for the help at the top of the form:

Managed files are files with a database record. This step allows you to copy these files from the Drupal 7 site into the files directory of the Backdrop site. Note that the public files directory may contain several files without a database record, such as default images and image styles.

Question: is the purpose of mentioning non-managed files in the public files directory to let people know that this process will not copy such files? Is so, then that should be another notice/warning I think.
for the 2 radio options:
- Skip this step and manually copy the files later (recommended)
- Automatically copy any managed files
  
  This requires the file URL to be known and accessible over http.
for the warning:

This method is unreliable! Use this tool with caution.

Thoughts/suggestions?

klonos commented 3 months ago

Another important question that will play a role in what text we should use in this form: if people decide to copy files manually, are they meant to do that BEFORE they proceed to the next step, or can it be done after the upgrade has finished?

stpaultim commented 3 months ago

@klonos Having experimented with this module quite a bit, I think I can say with some confidence that it doesn't matter at all when the files are moved. I've done it before starting the process, at this point in the process, or when the process is complete - and the results have always been the same.

Doing it before the end is better, because then your site looks better when the upgrade is complete. But it can be done after that as well.

backdrop-contrib / d2b_migrate

Improve Files Backdrop stage of process - or improve help text #58