FiveTwentyEight - Provide concrete details about civicrm.files

[totten]

Overview

@kcristiano I was taking another look at the upgrade messaging and wondering about an inexperienced admin would interpret phrases like "a legacy (wp-content/plugins/files/civicrm) or non-standard directory structure". I agree with these, of course - it just helps to have the longer context.

But I think it may be easier to interpret (on the first impression) if we show the values more concretely.

Before

Message describes the paths in general terms.

After

Message provides the concrete values that are detected by the old/new functions. This serves two aims:

1. Give enough info to make a quick decision on whether they need to read the longer document
2. If they do need the longer document, give a reference to make the details clearer.

I've run this on two local builds - one which used the recent-style uploads/civicrm:

The other uses the older-style plugins/files/civicrm:

The upcoming content of the doc link is at https://github.com/civicrm/civicrm-sysadmin-guide/pull/260/files. I've updated the draft a bit to provide more linking words. I also tried to follow @gah242s's point that [civicrm.files] seems more googleable/research-able.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[kcristiano]

@totten I agree this messaging is preferred.

I did an r-run
'legacy paths/urls'

'current paths/urls'

I think this should be merged. Thanks for working on this

[gah242s]

That makes sense. I was looking at it from the perspective of a sysadmin that set it up ten years ago and has been just letting it mostly ride. Probably better to focus on the new than the old in this instance. However, having the path in the description would make things click for a long-term semi-engaged admin that’s going to get caught flat-footed.

…

On Jul 31, 2020, at 7:44 AM, Kevin Cristiano ***@***.***> wrote: @totten <https://github.com/totten> I agree this messaging is preferred. I did an r-run <https://user-images.githubusercontent.com/1892544/89031977-98310980-d301-11ea-8b31-97f5c08b1b70.png> I think this should be merged. Thanks for working on this — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#18011 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHE6FJX545BVXYRR5ONQT3R6KVCHANCNFSM4PP7E6LQ>.

[totten]

Thanks @kcristiano @gah242s. Merging.

Test failures are unrelated.