Contrib.social

[META] Fix up topics to use new help_route_link function

Open on Drupal.org →
Created on 26 May 2021, about 3 years ago
Updated 21 April 2023, about 1 year ago

Problem/Motivation

This issue is undergoing re-scoping and is now a META issue. No further patches should be uploaded to this issue. Please see the child issues below to complete work on patches or review.

On 📌 Make a way for help topics to generate links only if they work and are accessible Fixed , we've added two new functions for making safe links with access checks in help topics.
Related change record is https://www.drupal.org/node/3192582 →

As an example, this is how the block.place.html.twig file was updated in the patch on that issue (that was the only production topic that was updated):

-{% set layout_url = render_var(url('block.admin_display')) %}
+{% set layout_link_text %}
+{% trans %}Block layout{% endtrans %}
+{% endset %}
+{% set layout_link = render_var(help_route_link(layout_link_text, 'block.admin_display')) %}
 
...

-  <li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> &gt; <a href="{{ layout_url }}"><em>Block layout</em></a>.{% endtrans %}</li>
+  <li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> &gt; {{ layout_link }}.{% endtrans %}</li>

...

-  <li>{% trans %}Configure the block and click <em>Save block</em>; see <a href="{{ configure }}">Configuring a previously-placed block</a> for configuration details.{% endtrans %}</li>
+  <li>{% trans %}Configure the block and click <em>Save block</em>; see {{ configure_topic }} for configuration details.{% endtrans %}</li>

Steps to reproduce

N/A

Proposed resolution

  1. [done]
  2. Fix up the rest of the topics in core/modules/help_topics/help_topics to use the new help_route_link function.

Child issues

Remaining tasks

  1. Complete work on all child issues.
  2. After child issues are fixed, ensure that no remaining links need to be updated to use the new help_route_link function in any help topic.
  3. Create any necessary follow-up issues or add to 📌 Fix up minor copy problems in help topics Fixed

User interface changes

None.

API changes

None.

Data model changes

None.

Release notes snippet

Not necessary. This is an Experimental module.

🌱 Plan
Status

Fixed

Version

10.1 ✨

Component
Help  →

Last updated 20 days ago

No maintainer
Created by

🇫🇷France andypost

Live updates comments and jobs are added and updated live.
  • Needs subsystem maintainer review

    It is used to alert the maintainer(s) of a particular core subsystem that an issue significantly impacts their subsystem, and their signoff is needed (see the governance policy draft for more information). Also, if you use this tag, make sure the issue component is set to the correct subsystem. If an issue significantly impacts more than one subsystem, use needs framework manager review instead.

  • Needs release manager review

    It is used to alert the release manager core committer(s) that an issue significantly affects the overall technical debt or release timeline of Drupal, and their signoff is needed. See the governance policy draft for more information.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024