Problem/Motivation

In core documentation, there are still many references to the old drupal theming guide url: https://www.drupal.org/docs/8/theming.

While these do resolve on a redirect, these links should be updated to the new url: https://www.drupal.org/docs/develop/theming-drupal.

Steps to reproduce

Search core files for references to https://www.drupal.org/docs/8/theming. There are still a handful of files.

Proposed resolution

Update the url from https://www.drupal.org/docs/8/theming to https://www.drupal.org/docs/develop/theming-drupal

Remaining tasks

Review the documentation changes.

User interface changes

None

API changes

none

Steps to validate

  1. Check the links in the MR to 11.2.x.
  2. The updated links all resolve to the correct url.
  3. Search codebase and confirm are no links which were missed.

Issue fork drupal-3230281

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

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

I am assigning this to myself as I am showing a group of new contributors the patching and MR process. Please reserve this issue for that group.

We will be posting patches, reviewing the patches, and then rolling the patches into merge requests

We will be working on this over the course of a few days to a week. Thanks for your patience.

volkswagenchick’s picture

Issue summary: View changes

updating summary

andysipple’s picture

Aloha, here's a patch for the following files including a few more I found in bold.

  • core/themes/stark/stark.info.yml
  • core/themes/stark/README.txt
  • core/themes/stable9/README.txt
  • core/themes/stable/README.txt
  • core/themes/seven/README.txt
  • core/themes/classy/README.txt
  • core/themes/bartik/README.txt
  • core/INSTALL.txt
  • core/lib/Drupal/Core/Render/theme.api.php
  • core/modules/help_topics/help_topics/core.appearance.html.twig
  • core/profiles/demo_umami/themes/umami/README.txt
  • core/themes/classy/classy.info.yml
volkswagenchick’s picture

Issue summary: View changes
Status: Active » Needs review

Thanks for finding more files to fix, added them to the summary.

Setting status to need review. We have two more folks that are going to upload patches from the workshop. Again, we are using this as a learning experience and thank you for your patience.

mikohl’s picture

Here is my version of the patch to update the links to the Drupal Theming Guide.

Files affected:

  • /core/INSTALL.txt
  • /core/lib/Drupal/Core/Render/theme.api.php
  • /core/modules/help_topics/help_topics/core.appearance.html.twig
  • /core/profiles/demo_umami/themes/umami/README.txt
  • /core/themes/bartik/README.txt
  • /core/themes/classy/README.txt
  • /core/themes/classy/classy.info.yml
  • /core/themes/seven/README.txt
  • /core/themes/stable/README.txt
  • /core/themes/stable9/README.txt
  • /core/themes/stark/README.txt
  • /core/themes/stark/stark.info.yml
quietone’s picture

Issue tags: -Documentation

Removing documentation tag according to Issue tags -- special tags.

+++ b/core/themes/seven/README.txt
@@ -16,5 +16,5 @@ see https://www.drupal.org/node/2582945 for more info.
+See https://www.drupal.org/docs/theming-drupal for more information on Drupal 8

Elsewhere in this patch the '8' was removed. Is that a change that should be made here or in a separate patch.

I think it will help reviewers if the IS included how the links are being found. Hopefully, it is a simple grep command.

mikohl’s picture

Applied patch in #4 and grepped for "https://www.drupal.org/docs/8/theming" in the /core directory. No further instances of links with this URL were found.

There are several mentions of "Drupal 8" in the files and in descriptions of links. Should these be changed to "Drupal" without the version number?

  1. +++ b/core/lib/Drupal/Core/Render/theme.api.php
    @@ -31,7 +31,7 @@
      * For further information on theming in Drupal 8 see
    

    Should version number be removed in this description?

  2. +++ b/core/themes/seven/README.txt
    @@ -16,5 +16,5 @@ see https://www.drupal.org/node/2582945 for more info.
    +See https://www.drupal.org/docs/theming-drupal for more information on Drupal 8
    

    Should the version number be removed in this line of text?

volkswagenchick’s picture

Issue summary: View changes
Status: Needs review » Needs work

I agree with removing the version number and having it be more evergreen.

Updated issue summary to include steps to validate .

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

markie’s picture

Created an issue fork for demonstration purposes only using patch #6. keeping as needs work since changes to that patch were requested.

mikohl’s picture

Status: Needs work » Needs review

Pulled updated code and created updated merge request as part of this exercise. Patch still applies cleanly and leaves no instances of the "https://www.drupal.org/docs/8/theming" theming url when I grep through the core directory.

This is my first merge request, so please let me know if I need to make any corrections.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned

I am unassigning myself from this issue. Thanks for the continued patience while a group of novice contributors worked on patches, reviews, and merge requests

volkswagenchick’s picture

Issue tags: +Europe2021, +Novice

Tagging for DrupalCon Europe2021 and novice. Thanks

asirjacques’s picture

I am working on reviewing an testing this as part of the contribution event at DrupalCon Europe 2021.

asirjacques’s picture

Review summary:
==============
- Compare changes between the 2 branches - Branch 3230281-link-to-drupal can be closed.

- Use DrupalPod and manually test:
core/modules/help_topics/help_topics/core.appearance.html.twig - Click link - It works.

- Review the README.txt files: Change has been made. Looks good.

- Review core/themes/classy/classy.info.yml and core/themes/stark/stark.info.yml - It works.

asirjacques’s picture

Status: Needs review » Reviewed & tested by the community
mradcliffe’s picture

Status: Reviewed & tested by the community » Needs work
antojose’s picture

Issue summary: View changes

Updated the issue summary with the relevant merge request from the two mentioned above.

antojose’s picture

Hiding the patches to make it clearer to the committer.

vicheldt’s picture

Assigned: Unassigned » vicheldt

I noticed that there's still some places that miss some changes, because Drupal 9 also uses Twig so i'll change that.

vicheldt’s picture

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

Just changed 2 files: 'lib/Drupal/Core/Render/theme.api.php' and 'modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php'.

vikashsoni’s picture

StatusFileSize
new210.9 KB

Patch not appliying trying to apply patch in drupal-9.3.x-dev

SomeIntern’s picture

Patch failed to apply in 9.4.x at core/lib/Drupal/Core/Render/theme.api.php

SomeIntern’s picture

Status: Needs review » Reviewed & tested by the community

MR1242 applied cleanly to 9.3x, confirmed links worked in local environment. Search revealed no more occurrences of out dated links. Setting to RTBC.

lauriii’s picture

Status: Reviewed & tested by the community » Needs work

Posted feedback on the MR

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

gquisini’s picture

Assigned: Unassigned » gquisini

I'm working on.

gquisini’s picture

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

changed outdated links and title to new version.

New file affected:
- /core/modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php

lucassc’s picture

Assigned: Unassigned » lucassc

I'll review the changes.

lucassc’s picture

Assigned: lucassc » Unassigned
Status: Needs review » Reviewed & tested by the community

All links worked and search didn't reveal any occurrences of outdated links.

quietone’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs reroll

I could not apply the MR locally to 9.5.x, I guess we need a rebase here.

@vikashsoni, Screenshots are not needed to prove a patch does not apply, removing credit.

arunkumark’s picture

Status: Needs work » Needs review
StatusFileSize
new9.55 KB

Patch has been re-rolled to support on Drupal 9.5.x branch.

vinmayiswamy’s picture

Applied patch #37 successfully in Drupal 9.5.x-dev.
Thanks for the patch @arunkumark

anjali rathod’s picture

Status: Needs review » Reviewed & tested by the community

The patch looks good to me , thanks @arunkumark !

quietone’s picture

Title: Link to Drupal Theming Guide in READMES and info files are antiquated » Update links in Drupal Theming Guide in READMES and info files
Issue summary: View changes
Status: Reviewed & tested by the community » Needs work
Issue tags: -Needs reroll

Thanks for working on this, it will be nice to have the links updated.
@lucassc, thanks for reviewing and testing this lnks!

@arunkumark, after you have rerolled a patch, remove the 'needs reroll' tag so everyone knows the work is done.
@VinmayiSwamy, it is not necessary to comment that a patch applies, the testbot will let us know.
@Anjali Rathod, when Review a patch or merge request is expected that that done more than look at the patch. For example, comment that you confirmed that it fixes what is stated in the Issue summary, all comment feedback has been address and in this case that you verify that the new links work.

I took a brief look a the patch, this is not a complete review of the patch.

  1. +++ b/core/modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php
    @@ -13,7 +13,7 @@
    + * @see https://www.drupal.org/docs/theming-drupal-drupal-8/working-with-breakpoints-in-drupal-8
    ...
      * @MigrateSource(
    

    This link does not work. I have not checked the other links.

  2. +++ b/core/profiles/demo_umami/themes/umami/README.txt
    @@ -4,8 +4,8 @@ ABOUT UMAMI
    -ABOUT DRUPAL THEMING
    +ABOUT THEMING DRUPAL
    

    I wondered about this change because the title says this is about links. But then I saw in the IS that this change was proposed. And then I found that the themeing guide on the wiki is titled, "Theming Drupal', so maybe this is OK.

I tweaked the title but not sure I got it right.

sourabhjain’s picture

Assigned: Unassigned » sourabhjain

I will work on this.

sourabhjain’s picture

Status: Needs work » Needs review
StatusFileSize
new9.62 KB
new734 bytes

I have resolved the point 1 mentioned in comment #41.
Please review

sourabhjain’s picture

Assigned: sourabhjain » Unassigned
volkswagenchick’s picture

Issue tags: +Prague2022

Tagging this for Prague2022.

Issue summary and remaining tasks can be updated.
Let's also create a merge request vs a patch.

Please reserve this issue for first time contributors in Prague 2022.

nataliajustice’s picture

Status: Needs review » Reviewed & tested by the community

Hi, I am at the Mentor Sprints of the Drupal Prague 2022 and I reviewed the Merge request !1178 mentioned at the summary: https://git.drupalcode.org/project/drupal/-/merge_requests/1178

Everything seems to be fine and all the links are working as expected. I will change the status to "Reviewed & tested by the community".

lauriii’s picture

Status: Reviewed & tested by the community » Needs work

The patch from #43 failed to apply

lucassc’s picture

Assigned: Unassigned » lucassc
Issue tags: +Needs reroll
lucassc’s picture

Assigned: lucassc » Unassigned
Status: Needs work » Needs review
Issue tags: -Needs reroll
StatusFileSize
new9.68 KB
new696 bytes

I got a little confused with the branches, so I not sure if this is right but... I rerolling #43 against branch 9.5.x.

I noticed the link was updated in core/modules/help_topics/help_topics/core.appearance.html.twig but the content inside the <a> tag remained "Theming Drupal 8". I updated this (check interdiff_43-49.txt attached)

lucassc’s picture

StatusFileSize
new9.68 KB
new722 bytes

Same for core/themes/classy/classy.info.yml.

gquisini’s picture

Assigned: Unassigned » gquisini

I'll be reviewing

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

diegors’s picture

Worked with @lucassc to fix the MR problem, just made and rebase and commit on MR !2820

gquisini’s picture

Assigned: gquisini » Unassigned

I was going to review MR !1178, but since there was a comment saying "The branch 3230281-link-to-drupal is a duplicate of 3230281-6mm. The merge request 1178 can be closed.". I was in doubt, so I reviewed the last MR.

Files that I checked:
[x] - core/INSTALL.txt
[x] - core/lib/Drupal/Core/Render/theme.api.php
[x] - modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php
[x] - core/modules/help_topics/help_topics/core.appearance.html.twig
[x] - core/profiles/demo_umami/themes/umami/README.txt
[x] - core/themes/bartik/README.txt
[x] - core/themes/classy/README.txt
[x] - core/themes/classy/classy.info.yml
[x] - core/themes/seven/README.txt
[x] - core/themes/stable/README.txt
[x] - core/themes/stable9/README.txt
[x] - core/themes/stark/README.txt
[x] - core/themes/stark/stark.info.yml

Could we change these things?
- core/themes/classy/README.txt: The link (https://www.drupal.org/docs/theming-drupal-drupal-8/using-classy-as-a-ba...) redirects to 404. I could't find a new link;
- core/themes/seven/README.txt: The link (https://www.drupal.org/docs/8/core/themes/seven-theme) redirects to (https://www.drupal.org/docs/contributed-themes/seven-theme-0/seven-theme...);

Things that I changed:
- classy.info.yml: I changed the link title to "Theming Drupal"
- core/modules/help_topics/help_topics/core.appearance.html.twig: I changed the link title to "Theming Drupal'

lucassc’s picture

Status: Needs review » Needs work

Things that @gquisini changed looks good, they are related with my considerations in #49 and #50.

Changing status to "Needs work" so we can verify the points in "Could we change these things?" of his comment #55.

adaucyj’s picture

HI, everyone. Searching for "drupal calssy base theme" through Google, I found this link https://www.drupal.org/theme-guide/8/classy which redirects to https://www.drupal.org/docs/theming-drupal/sub-theming-using-stablestable-9-as-a-base-theme. I really don't understand why.
Maybe we could open a child issue regarding to this documentation.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

chandravilas’s picture

StatusFileSize
new4.03 KB

Added Drupal Theming Guide links in readme.

chandravilas’s picture

Status: Needs work » Needs review
smustgrave’s picture

Status: Needs review » Needs work
Issue tags: +Needs issue summary update

This desperately needs an issue summary update. Between the MR and patches things are bouncing back and forth and afraid something will be missed. So it should be documented for reviewers.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

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

mdranove’s picture

Issue summary: View changes
Status: Needs work » Needs review

Added new MR to 11.2.x. Updated issue summary.

mdranove changed the visibility of the branch 3230281-drupal-theming-guide-links to hidden.

mdranove changed the visibility of the branch 3230281-link-to-drupal-theming to hidden.

mdranove changed the visibility of the branch 3230281-link-to-drupal to hidden.

mdranove changed the visibility of the branch 3230281-6mm to hidden.

mdranove changed the visibility of the branch 3230281-issue to hidden.

mdranove changed the visibility of the branch 9.5.x to hidden.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

mdranove’s picture

Status: Needs work » Needs review
ankitv18’s picture

Status: Needs review » Reviewed & tested by the community

MR!13404 changes covered all the required updates, https://www.drupal.org/docs/8/theming isn't exists in the codebase.

astonvictor’s picture

+1 RTBC

xjm’s picture

xjm’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: -Needs issue summary update

This issue is currently doing a lot more than correcting outdated references to https://www.drupal.org/docs/8/theming. 😀 Comments on MR. Thanks everyone!

mdranove’s picture

Status: Needs work » Needs review
Related issues: +#3553402: Remove text references to "Drupal 8"

Updated based on feedback. Moving to needs review.

Also opened 3553402 to address textual references to "Drupal 8".

dcam’s picture

Status: Needs review » Reviewed & tested by the community

All feedback has been addressed. I was concerned about the lack of full stops (periods) at the end of a couple of lines, but after doing a little research I decided not to hold this up on that point. There doesn't seem to be a consensus in the Core docs about whether a full stop should come after a URL and this isn't the place to go into that.

I checked for other instances of that old URL with grep -r "https://www.drupal.org/docs/8/theming" ./ and found none. All of the URLs updated by the MR go to the correct pages. There's no more out-of-scope changes. This looks RTBC to me.

  • quietone committed 0e616139 on 11.3.x
    Issue #3230281 by volkswagenchick, andysipple, mikohl, quietone,...

  • quietone committed ef890330 on 11.x
    Issue #3230281 by volkswagenchick, andysipple, mikohl, quietone,...
quietone’s picture

Version: 11.x-dev » 11.3.x-dev
Status: Reviewed & tested by the community » Fixed

This is the first issue I have come across with 7 Merge Requests. In Drupal, there is little need to create an MR on an issue, we work collaboratively on a single MR. Still, there are exceptions like trying a new approach which doesn't apply here. In any case there is lots of useful information for working with Merge Requests in the pages of the guide, Using GitLab to contribute to Drupal.

Thanks for keeping this in scope so it could be completed. The change at line 382 in INSTALL.txt introduced a whitespace error that was fixed on commit.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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