Problem/Motivation

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.

The moved help topics should also be added to this Contrib incarnation of quickedit.
Since the Contrib quickedit module at this point in time should still be a 1-on-1 copy of the Core module, this should be relatively easy. (#FamousLastWords)

Steps to reproduce

Proposed resolution

Remaining tasks

Do stuff

User interface changes

API changes

Data model changes

Issue fork quickedit-3264949

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Spokje created an issue. See original summary.

spokje’s picture

Title: Move quickedit help topics to Contrib quickedit module » [PP-1] Move quickedit help topics to Contrib quickedit module
Status: Active » Postponed

Let's wait until we have the blessing for the layout and wording on the Core issue #3264945: Move quickedit help topics to quickedit module before we do the copy-paste dance.

spokje’s picture

Title: [PP-1] Move quickedit help topics to Contrib quickedit module » Move quickedit help topics to Contrib quickedit module
Status: Postponed » Needs work

Blocker committed, unpostponing.

spokje’s picture

Status: Needs work » Needs review
dww’s picture

Assigned: spokje » dww

Sweet, thanks! Reviewing now.

dww’s picture

Assigned: dww » Unassigned
Status: Needs review » Needs work

Drat, I suck, sorry. I just noticed some problems with this help text, but only one of them is specific to it living in contrib. I think we might want a fast-follow-up for the core issue to fix a few of these points.

dww’s picture

Title: Move quickedit help topics to Contrib quickedit module » [PP-1] Move quickedit help topics to Contrib quickedit module
Status: Needs work » Postponed

Let's fix most of these at #3265492: Fix inaccuracies in quickedit help topic (after the split from settings_tray) and circle back. Thanks/sorry.

spokje’s picture

Issue summary: View changes

Fixed typo

andypost’s picture

spokje’s picture

Title: [PP-1] Move quickedit help topics to Contrib quickedit module » Move quickedit help topics to Contrib quickedit module
Assigned: Unassigned » spokje
Status: Postponed » Needs work
spokje’s picture

Assigned: spokje » Unassigned

Let's cut a new release for Quick Edit first, after the removal has landed. The current version here differs quite a lot from the one in Core ATM.

xjm’s picture

#12 creates a bit of a circular dependency, because we need to remove the QE stuff from Help Topics in order to remove QE from core. So I think we need to do this issue first.

andypost’s picture

help topic will not fail if route is missing, so this issue looks more like about "removing core mentions" in QE topic

Also please include #3215784: [META] Fix up topics to use new help_route_link function

wim leers’s picture

wim leers’s picture

Title: Move quickedit help topics to Contrib quickedit module » Move Quick Edit help topics to contrib Quick Edit module
phenaproxima’s picture

Quick Edit has been removed from core, so I'm thinking that what might be easiest here is to just, like, commit what we have and do any further wordsmithing in a follow-up. Thoughts?

wim leers’s picture

Sounds reasonable to me!

longwave made their first commit to this issue’s fork.

longwave’s picture

Status: Needs work » Needs review

This MR was opened before #3265492: Fix inaccuracies in quickedit help topic (after the split from settings_tray) which updated the text to include some of @dww's suggestions from this issue. I have applied the patch from that issue to the MR so it should now be an exact copy of what we have in 9.5.x.

I agree with #17/#18 that any further changes to the text should be done in a followup.

wim leers’s picture

@phenaproxima: Do you mind reviewing? Then I can commit :)

phenaproxima’s picture

Status: Needs review » Reviewed & tested by the community

I checked out the MR branch, and compared it against HEAD of core 9.5.x with this command:

git diff --no-index help_topics/quickedit.quick_edit.html.twig ../../core/modules/quickedit/help_topics/quickedit.quick_edit.html.twig

Nothing came up, which would seem to confirm that the files are identical. Therefore, I think this is RTBC.

wim leers’s picture

Status: Reviewed & tested by the community » Fixed

Looks like this actually was already committed:

$ git l --  help_topics
* 2ccf485fc4a8aa6eac1a2d983c99f380e7006b7b Issue #3265492 by dww, Spokje, Amber Himes Matz, quietone: Fix inaccuracies in quickedit help topic (after the split from settings_tray)
* 5a8bbbc1fc4894106a832d4965e028eabbe3ac32 Issue #3264945 by Spokje, dww: Move quickedit help topics to quickedit module

and

$ git show 2ccf485fc4a8aa6eac1a2d983c99f380e7006b7b
commit 2ccf485fc4a8aa6eac1a2d983c99f380e7006b7b
Author: catch <catch@35733.no-reply.drupal.org>
Date:   Mon Jun 13 21:28:06 2022 +0100

    Issue #3265492 by dww, Spokje, Amber Himes Matz, quietone: Fix inaccuracies in quickedit help topic (after the split from settings_tray)
    
    (cherry picked from commit cc39d49fb1d1f3782ac600f0a5c2d5d9e6fb0945)

diff --git a/help_topics/quickedit.quick_edit.html.twig b/help_topics/quickedit.quick_edit.html.twig
index 3b10f6d..c267721 100644
--- a/help_topics/quickedit.quick_edit.html.twig
+++ b/help_topics/quickedit.quick_edit.html.twig
@@ -9,12 +9,12 @@ related:
 <h2>{% trans %}What is quick editing?{% endtrans %}</h2>
 <p>{% trans %}Quick editing is editing content inline. Content quick editing is provided by the core Quick Edit module or its contributed replacement. It requires the core Contextual Links module in order to expose the links that let you edit in place.{% endtrans %}</p>
 <h2>{% trans %}Who can edit content in place?{% endtrans %}</h2>
-<p>{% trans %}In order to follow these steps to edit content in place, the core Quick Edit module or its contributed replacement must be installed. Also, either the core Toolbar module or a contributed replacement must be installed. You will need to have <em>Use contextual links</em> permission, as well as permission to edit the particular content.{% endtrans %}</p>
+<p>{% trans %}In order to follow these steps to edit content in place, the core Quick Edit module or its contributed replacement must be installed. Also, either the core Toolbar module or a contributed replacement must be installed. You will need to have <em>Use contextual links</em> permission, <em>Access in-place editing</em> permission, as well as permission to edit the particular content.{% endtrans %}</p>
 <h2>{% trans %}Steps{% endtrans %}</h2>
 <ol>
   <li>{% trans %}Find and visit a page on your site that has the content that you would like to edit.{% endtrans %}</li>
   <li>{% trans %}Click the contextual links <em>Edit</em> button on the toolbar (in most themes, it looks like a pencil). Contextual <em>Edit</em> links with the same icon will appear all over your page.{% endtrans %}</li>
-  <li>{% trans %}Find the contextual link for the part of the page you want to edit. For example, if you want to edit the content of a block, the link should be in the top-right corner of the block, or top-left for right-to-left languages.{% endtrans %}</li>
-  <li>{% trans %}Click the link to open the contextual links menu, and click <em>Quick edit</em>. An editing form for the content should appear on the page.{% endtrans %}</li>
+  <li>{% trans %}Find the contextual link for the part of the page you want to edit. For example, to edit a specific post on the front page, the link should be in the top-right corner of the post, or top-left for right-to-left languages.{% endtrans %}</li>
+  <li>{% trans %}Click the link to open the contextual links menu, and click <em>Quick edit</em>. All editable fields will be enclosed in a light blue box. Hover over any box to see the label of the field that box contains. Click on the box and a form to edit that field will appear.{% endtrans %}</li>
   <li>{% trans %}Make your edits and submit the form.{% endtrans %}</li>
 </ol>

🤷‍♀️

Well, at least @phenaproxima confirmed that what's in the contrib module right now does match upstream!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.