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
- Check the links in the MR to 11.2.x.
- The updated links all resolve to the correct url.
- Search codebase and confirm are no links which were missed.
| Comment | File | Size | Author |
|---|
Issue fork drupal-3230281
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:
- 3230281-drupal-theming-guide-links
changes, plain diff MR !2820
- 9.5.x
changes, plain diff MR !2500
- 3230281-link-to-drupal-theming
changes, plain diff MR !2454
- 3230281-link-to-drupal
changes, plain diff MR !1178
- 3230281-6mm
changes, plain diff MR !1242
- drupal-theme-guide-updates-drupal-11.x
changes, plain diff MR !13414
- drupal-theme-guide-updates-drupal-11
changes, plain diff MR !13404
- 3230281-issue
compare
Comments
Comment #2
volkswagenchickI 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.
Comment #3
volkswagenchickupdating summary
Comment #4
andysipple commentedAloha, here's a patch for the following files including a few more I found in bold.
Comment #5
volkswagenchickThanks 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.
Comment #6
mikohl commentedHere is my version of the patch to update the links to the Drupal Theming Guide.
Files affected:
Comment #7
quietone commentedRemoving documentation tag according to Issue tags -- special tags.
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.
Comment #8
mikohl commentedApplied 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?
Should version number be removed in this description?
Should the version number be removed in this line of text?
Comment #9
volkswagenchickI agree with removing the version number and having it be more evergreen.
Updated issue summary to include steps to validate .
Comment #12
markie commentedCreated an issue fork for demonstration purposes only using patch #6. keeping as needs work since changes to that patch were requested.
Comment #14
mikohl commentedPulled 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.
Comment #15
volkswagenchickI am unassigning myself from this issue. Thanks for the continued patience while a group of novice contributors worked on patches, reviews, and merge requests
Comment #16
volkswagenchickTagging for DrupalCon
Europe2021andnovice. ThanksComment #17
asirjacques commentedI am working on reviewing an testing this as part of the contribution event at DrupalCon Europe 2021.
Comment #18
asirjacques commentedReview 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.
Comment #19
asirjacques commentedComment #20
mradcliffeComment #21
antojoseUpdated the issue summary with the relevant merge request from the two mentioned above.
Comment #22
antojoseHiding the patches to make it clearer to the committer.
Comment #23
vicheldt commentedI noticed that there's still some places that miss some changes, because Drupal 9 also uses Twig so i'll change that.
Comment #24
vicheldt commentedJust changed 2 files: 'lib/Drupal/Core/Render/theme.api.php' and 'modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php'.
Comment #25
vikashsoni commentedPatch not appliying trying to apply patch in drupal-9.3.x-dev
Comment #26
SomeIntern commentedPatch failed to apply in 9.4.x at core/lib/Drupal/Core/Render/theme.api.php
Comment #27
SomeIntern commentedMR1242 applied cleanly to 9.3x, confirmed links worked in local environment. Search revealed no more occurrences of out dated links. Setting to RTBC.
Comment #28
lauriiiPosted feedback on the MR
Comment #31
gquisini commentedI'm working on.
Comment #32
gquisini commentedchanged outdated links and title to new version.
New file affected:
- /core/modules/responsive_image/src/Plugin/migrate/source/d7/ResponsiveImageStyles.php
Comment #34
lucasscI'll review the changes.
Comment #35
lucasscAll links worked and search didn't reveal any occurrences of outdated links.
Comment #36
quietone commentedI 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.
Comment #37
arunkumarkPatch has been re-rolled to support on Drupal 9.5.x branch.
Comment #39
vinmayiswamy commentedApplied patch #37 successfully in Drupal 9.5.x-dev.
Thanks for the patch @arunkumark
Comment #40
anjali rathodThe patch looks good to me , thanks @arunkumark !
Comment #41
quietone commentedThanks 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.
This link does not work. I have not checked the other links.
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.
Comment #42
sourabhjainI will work on this.
Comment #43
sourabhjainI have resolved the point 1 mentioned in comment #41.
Please review
Comment #44
sourabhjainComment #45
volkswagenchickTagging 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.
Comment #46
nataliajustice commentedHi, 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".
Comment #47
lauriiiThe patch from #43 failed to apply
Comment #48
lucasscComment #49
lucasscI 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.twigbut the content inside the<a>tag remained "Theming Drupal 8". I updated this (check interdiff_43-49.txt attached)Comment #50
lucasscSame for
core/themes/classy/classy.info.yml.Comment #51
gquisini commentedI'll be reviewing
Comment #54
diegorsWorked with @lucassc to fix the MR problem, just made and rebase and commit on
MR !2820Comment #55
gquisini commentedI 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'
Comment #56
lucasscThings 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.
Comment #57
adaucyjHI, 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.
Comment #59
chandravilasAdded Drupal Theming Guide links in readme.
Comment #60
chandravilasComment #61
smustgrave commentedThis 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.
Comment #65
mdranove commentedAdded new MR to 11.2.x. Updated issue summary.
Comment #72
needs-review-queue-bot commentedThe 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.
Comment #75
mdranove commentedComment #76
ankitv18 commentedMR!13404 changes covered all the required updates,
https://www.drupal.org/docs/8/themingisn't exists in the codebase.Comment #77
astonvictor commented+1 RTBC
Comment #78
xjmComment #79
xjmThis issue is currently doing a lot more than correcting outdated references to
https://www.drupal.org/docs/8/theming. 😀 Comments on MR. Thanks everyone!Comment #80
mdranove commentedUpdated based on feedback. Moving to needs review.
Also opened 3553402 to address textual references to "Drupal 8".
Comment #81
dcam commentedAll 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.Comment #84
quietone commentedThis 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.