Convert admin UI-related modules: contextual, help, inline_form_errors, quickedit, settings_tray, shortcut, toolbar, tour module hook_help() to topic(s)

I have made the patch for the above mentioned modules.
Please review.

I have made the patch for the above mentioned modules.
Please review.

I tried this patch, here adding few suggestions.
1. Using the administrative toolbar
- The heading itself says about administrative toolbar it is making confusion with admin toolbar(contrib) and toolbar(core) modules. Need to be explained about toolbar module in detail.

2. How to use the settings tray
- More detailed steps need to be added with navigation

3. Using the quick edit module
- Quick edit file name is not correct, it should me same as module name. Currently it is quick_edit.overview it should be quickedit.overview

4. Managing the shortcut
- Write with goal and detailed steps for shortcuts

@siddhant.bhosale patch is failing. Please have a look at it.

Thanks for the suggestions @jhodgdon and @snehalgaikwad. Will make the changes.

Hi, I have uploaded the patch with suggestions implemented.

Hi, I have uploaded the patch with suggestions implemented and fixed the coding standard.

Hi, I have uploaded the patch with suggestions implemented and fixed the coding standard. Also adding the interdiff of patches
help_topic-3095739-04.patch and help_topic-3095739-14.patch

The test case failed as there was one string which was not encoded in {% trans %}. Adding the changes.

I have reviewed the patch #24 and it's working fine as we expected in the 8.9.x version. Please find the attached screens.

@jhodgdon, Thanks for the patch. The patch covers help topics for inline_form_errors, quickedit, settings_tray, shortcut, toolbar, tour, contextual links. LGTM.

@jhodgdon, I have checked the patch in #24. I have verified the patch using the tasks mentioned for the review process against branch 9.1.

1. The text is written in clear, simple and in straightforward language.
2. Validated HTML, no issues found
3. Links within the text works.
4. Adheres to Standards for Help Topics.

Verified the grammar for the patch and found few minor issues for punctuation and grammar. Attaching a new patch with correction.

Thanks @jhodgdon for pointing out the issues. Validated both grammar and HTML. Language is also simple and straight forward. New suggested changes LGTM.

1. +++ b/core/modules/help_topics/help_topics/core.quick_edit.html.twig
   @@ -0,0 +1,18 @@
   +---
   +<h2>{% trans %}Goal{% endtrans %}</h2>
   +<p>{% trans %}Edit content or settings in place on a non-administrative page.{% endtrans %}</p>
   +<h2>{% trans %}What is quick editing?{% endtrans %}</h2>
   +<p>{% trans %}Quick editing is editing either content or settings inline while visiting a non-administrative page. Content quick editing is provided by the core Quick Edit module, and settings quick editing is provided by the core Settings Tray module; both of them require the core Contextual Links module in order to expose the links that let you edit in place on a non-administrative page.{% endtrans %}</p>
   +<h2>{% trans %}Steps{% endtrans %}</h2>
   +<ol>
   

   I'm not sure we need to use 'non-administrative' here. If an entity is rendered normally on an admin page, it will have quick edit links, and it will be possible to edit inline there too. For example you could have a block that shows on admin pages, and quickedit would let you edit that block inline without going to admin/structure/block.

   What this is really trying to say is that you don't have to go to a separate page to edit. I think we could just drop 'while visiting a non-administrative page' and 'on a non-administrative page'.

2. +++ b/core/modules/help_topics/help_topics/core.ui_components.html.twig
   @@ -4,15 +4,30 @@ top_level: true
   +<p>{% trans %}The administrative menu, which you can navigate by visiting <em>/admin</em> on your site or by using an administrative toolbar, has the following sections (some may not be available, depending on which modules are currently installed on your site):{% endtrans %}</p>
   +<ul>
   +  <li>{% trans %}<strong>Content:</strong> Find, manage, and create new pages; manage comments and files.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Structure:</strong> Place and edit blocks, set up content types and fields, configure menus, administer taxonomy, and configure some contributed modules.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Appearance:</strong> Switch between themes, install themes, and update existing themes.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Extend:</strong> Update, install, and uninstall modules.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Configuration:</strong> Configure the settings for various site functionality, including some contributed modules.{% endtrans %}</li>
   +  <li>{% trans %}<strong>People:</strong> Manage user accounts and permissions.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Reports:</strong> Display information about site security, necessary updates, and site activity.{% endtrans %}</li>
   +  <li>{% trans %}<strong>Help:</strong> Get help on using the administrative interface.{% endtrans %}</li>
   +</ul>
   

   This seems out of scope?

Addressed #51.1 in this patch. Also added an interdiff to reflect that. Please review.

I applied the patch and for me everything is correct, rtbc +1

1. +++ b/core/modules/help_topics/help_topics/core.quick_edit.html.twig
   @@ -0,0 +1,18 @@
   +<ol>
   +  <li>{% trans %}Make sure that the core Quick Edit and/or Settings Tray module is installed. Also, make sure that the core Contextual Links module is installed, as well as a toolbar module (the core Toolbar module or a contributed replacement).{% endtrans %}</li>
   

   Quick edit and settings tray both have explicit dependencies on the contextual links module, so there's no need to make sure that contextual links is installed.

   Settings tray has an explicit dependency on core toolbar, and quickedit doesn't.

   Really the modules are responsible for making sure that they work with the correct dependencies, not the site admin, so I think this bullet can be removed.

2. +++ b/core/modules/help_topics/help_topics/core.quick_edit.html.twig
   @@ -0,0 +1,18 @@
   +  <li>{% trans %}Find and visit a page on your site that has either content or settings that you would like to edit.{% endtrans %}</li>
   +  <li>{% trans %}Click the contextual links <em>Edit</em> button, which looks like a pencil and is usually located at one end of your toolbar. You should see pencil buttons appear all over your page.{% endtrans %}</li>
   +  <li>{% trans %}Find the pencil button for the content or setting you want to edit. Click the button to open the contextual links for that part of the page. For example, if you want to edit the settings for a block, the pencil button should be in the top-right corner of the block (top-left for right-to-left languages).{% endtrans %}</li>
   

   Can we show the pencil icon here?

Fix url generation with help_topic_link CR https://www.drupal.org/node/3192582

Mixed patch and interdiff names

+++ b/core/modules/help_topics/help_topics/core.ui_components.html.twig
@@ -9,11 +9,11 @@ related:
-  <li>{% trans %}{{ accessibility }}, to enable all users to perform administrative tasks.{% endtrans %}</li>
+  <li>{% trans %}Accessibility features, to enable all users to perform administrative tasks. See {{ accessibility }} for more information.{% endtrans %}</li>
...
-  <li>{% trans %}In-place or <em>quick</em> editing. In-place editing of content is provided by the core Quick Edit module, and in-place editing of configuration is provided by the core Settings Tray module. See the {{ quick_edit }} for more information.{% endtrans %}</li>
+  <li>{% trans %}In-place or <em>quick</em> editing. In-place editing of content is provided by the core Quick Edit module, and in-place editing of configuration is provided by the core Settings Tray module. See {{ quick_edit }} for more information.{% endtrans %}</li>

Looks better, meantime I find having suffixes like (_topic, _link) useful

EDIT For example s/{{ accessibility }}/{{ accessibility_topic }}

@jhodgdon thank you!

I think it rtbc again

@ankit1114 please check it

Just 1 remark:
On the page using the administrative interface: Can we change "/admin" to a link in the sentence: "The administrative menu, which you can navigate by visiting /admin on your site or by using an administrative toolbar"

I followed the review process as described in the IS.
I all looks good to me.
For me it is RTBC.

Tested the Patch #72 by @jhodgdon, applied successfully and looks good to me.

core.quick_edit.html.twig
core.ui_accessibility.html.twig
core.ui_components.html.twig

RTBC + 1

1. +++ b/core/modules/help_topics/help_topics/core.quick_edit.html.twig
   @@ -0,0 +1,19 @@
   +  <li>{% trans %}Click the link to open the contextual links menu, and click <em>Quick edit</em>. An editing form for the settings or content should appear on the page.{% endtrans %}</li>
   

   This functionality relies on the quickedit module being enabled. Should we reference that?

   edit: we do that on the top level page, ignore

2. +++ b/core/modules/help_topics/help_topics/core.ui_components.html.twig
   @@ -4,15 +4,31 @@ top_level: true
   +<p>{% trans %}The administrative menu, which you can navigate by visiting <em>{{ admin_link }}</em> on your site or by using an administrative toolbar, has the following sections (some may not be available, depending on which modules are currently installed on your site):{% endtrans %}</p>
   

   The items visible will also depend on permissions.

   Should we mention that?

The point (#76.2) of @larowlan has been addressed. Back to RTBC.

Adding issue credits, unchecking @ilgnerfagundes - there's no need to provide screenshots that a patch applies. Unchecking @kleiton_rodrigues who provided a screenshot of a patch applied as well as a screenshot of one of the three topics added in this patch, we already had screenshots at that point. If you disagree with my assessment, please comment and I'll review. Please note https://www.drupal.org/node/2888804 for how we assign credit.

Committed 0f7faa6 and pushed to 9.3.x. Thanks!

Backported to 9.2.x because help topics is experimental.

Adjusting credit as described in #79. I happened to notice that @kleiton_rodrigues was not to be ticked.