Fix inaccuracies in quickedit help topic (after the split from settings_tray)

p.s. I wish there was a "try to apply it and check for code style / cspell, but don't bother running any real tests" option when uploading patches like this. 😉

Run All PHPUnit Tests The Way The Testbot Does It

and/or

core/drupalci.yml:

build:
  assessment:
    testing:
      # Run code quality checks.
      container_command.commit-checks:
        commands:
          - "core/scripts/dev/commit-code-check.sh --drupalci"
        halt-on-fail: true

Ah, I somehow thought you didn't know about drupalci.yml abuse.
(Which would be pretty weird since you've been around for a bit, come to think of it).

Never mind, move along, nothing to see here...

Blocks are config, not content.

This isn't the case for custom blocks - those are content entities, and should be editable with quickedit I think.

Yes, custom blocks are editable with quickedit. However, the change of the example to a piece of content on the front page is probably a bit better, easier to understand and follow, than one referring to a custom block which the site may not have.

I applied the patch and then went hunting for the page. I could not find it at /admin/help where none of the topics use the word 'edit'. I found it by using the text of one of the related items in quick_edit.html.twig in the URL. How is a user supposed to find this? Or am I being daft on a Friday evening? ... Pause I just found it. It is under 'Using the administrative interface'.

Once I got there I read the text and followed the steps to edit an article on the front page listing. The emphasis is used correctly, ready well and it worked.

The changes look fine to me. Is there anything else to do here?

Here's the RTBC part.

(Agreeing with @quietone's comment about the help topic being hard to find, but that's a possible follow IMHO)

Ok, I applied the patch in #5 and it created core/modules/quickedit/help_topics/quickedit.quick_edit.html.twig.

This is the file that will exist in Drupal 10. But in Drupal 9, all core module help_topics should still be in core/modules/help_topics/help_topics. At present this issue is labeled with version 9.4.x-dev. Is that an error?

My understanding is that this issue is only to correct the text. Am I applying the wrong patch?

To not-really-answer-but-explain the "findability" question, there are currently 3 ways to find help topics:

1. Browse the top level topics on admin/help (topics with top_level: true).
2. Click on a related link from a top level.
3. Use the search.

We do have an issue about making topics organized differently to help with findability:

https://www.drupal.org/project/drupal/issues/2960220

Regarding the standards question, our standards are outlined here:

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Which recommends following these UI text standards here:

https://www.drupal.org/drupalorg/style-guide/content

I'm not saying that all the help topics are in perfect alignment with those, so if there are issues, feel free to add follow ups. I cringe a bit at the use of "click". I prefer "select" as per Microsoft's style guide. But "click" is in the Drupal UI text guidelines at present.

Finally, I'm updating the issue summary's steps to reproduce to include enabling Help Topics.

Sorry, but setting back to needs review until the file placement and is this issue filed against the correct branch question are answered.

Actually, I think it needs work if the file is in the wrong place.

Sorry, but setting back to needs review until the file placement and is this issue filed against the correct branch question are answered.

@Amber Himes Matz in #12

File placement issue:

Ok, I applied the patch in #5 and it created core/modules/quickedit/help_topics/quickedit.quick_edit.html.twig.

This is the file that will exist in Drupal 10. But in Drupal 9, all core module help_topics should still be in core/modules/help_topics/help_topics.

@Amber Himes Matz in #12

I think the file placement issue has already been covered by @dww in #14.

Is this issue filed against the correct branch question:

At present this issue is labeled with version 9.4.x-dev. Is that an error?

@Amber Himes Matz in #12

I think/hope this quote from the IS of #3264949: Move Quick Edit help topics to contrib Quick Edit module will clear that up:

In #3264945: Move quickedit help topics to quickedit module the help topics related to the quickedit module are moved from the Core help_topics module to the Core quickedit module.

In Drupal 10 these help topics will be removed when the whole quickedit module will be removed.

So the quickedit help topics currently live in the quickedit module in both the 9.4.x and 10.0.x branch.

Since the whole quickedit module (and thus its help topics) will be removed from 10.0.x when #3227033: Remove Quick Edit from core lands we (or at least I) think that doing the changes in the issue against 10.0.x and backport to 9.4.x would be both a lot of effort for something that will be removed from 10.0.x shortly thereafter, and would even make it a blocker for #3227033: Remove Quick Edit from core.
Hence the reasoning to put this issue against 9.4.x only.

I hope I've (or basically @dww) explained it correctly and it all makes sense?

As far as I'm concerned this issue could go back to RTBC, but I hope that @Amber Himes Matz confirms the above ramblings are indeed an answer to both questions.

Ok, thank you both for the clarification! I didn't know about the deprecation policy with regard to help topics. This will certainly be relevant for a number of other core modules with help topics that are planned for removal in Drupal 10.

That was my only concern. Looks like the steps have been reviewed and approved, so marking this back to RTBC. Thank you all!

Committed/pushed to 10.0.x, cherry-picked to 9.5.x and 9.4.x, thanks!