Problem/Motivation
The comment for MenuTreeStorageInterface::loadTreeData() has a link that doesn't work.
* The tree order is maintained using an optimized algorithm, for example by
* storing each parent in an individual field, see
* https://www.drupal.org/node/141866 for more details. However, any details
* of the storage should not be relied upon since it may be swapped with a
* different implementation.
This page doesn't load, but searching for "drupal.org node 141866" will find it with a summary of what it used to be.
Here is a wayback machine link: https://web.archive.org/web/20201114001218/https://www.drupal.org/node/1...
There is a proposal to add a new link to replace the dead link here : https://www.drupal.org/project/drupal/issues/3518551
Steps to reproduce
TBD
Proposed resolution
Remove the dead link in the code comments because the content is no longer useful.
Remaining tasks
Make the change asked for in #11
Review the issue, checking that all questions have been answered and the change agrees with the issue summary. See https://www.drupal.org/community/contributor-guide/task/review-a-merge-request. You can do the steps that suit your interests, simply comment on what things you did.
Rebase the merge request, https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-dr...
User interface changes
N/A
Introduced terminology
N/A
API changes
N/A
Data model changes
N/A
Release notes snippet
N/A
Issue fork drupal-3517609
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:
- 11.x
compare
- 3517609-fix-broken-link
changes, plain diff MR !11766
Comments
Comment #2
quietone commentedComment #3
arunsahijpal commentedWorking on it.
Comment #5
mortona2k commentedIs the info still relevant? I'm not sure if it's documented anywhere else.
Comment #6
arunsahijpal commentedHi @mortona2k,
This doc was foundational reading for understanding how Drupal (especially 6 & 7) stored menu items, taxonomy terms, etc., before full-fledged entity trees and interfaces were in place.
Conceptually it is relevant but not for inline documentation that most devs read.
Comment #7
smustgrave commentedThink some replacement may be needed vs just removing, but IS is incomplete.
Comment #8
quietone commentedHaving a dead link is no use to anyone. I am fine with this removing that link only and having a followup to add documentation about menu ordering. One should search for an existing issue.
Comment #9
smustgrave commentedFair enough, but for good practice think the issue summary should still be complete
Comment #10
smustgrave commentedOpened https://www.drupal.org/project/drupal/issues/3518551
Comment #11
xjmI think the minimal scope here of removing the broken link is still a good novice task. We can simply remove the part of the sentence after the comma. The followup issue can handle adding additional content as needed from the historical reference.
The Drupal Contribution Mentoring team is triaging issues for DrupalCon Vienna 2025, and we are reserving this issue for Mentored Contribution during the event.
After October 17, this issue returns to being open to all. Thanks!
Comment #12
oily commentedApplied IS template, minimal removal and re-write of IS, updated the Remaining tasks.
Comment #13
oily commentedComment #14
quietone commentedComment #15
quietone commentedAfter questions in Slack, I am changing the title to be explicit.
Comment #17
suryantoI’ve reverted the text copy to the previous version and removed the dead link. I’ve implemented the change requested in #11.
Comment #18
quietone commented@suryanto, thanks for the change.
The next step here, which is still Novice level, is to review and decide if this can be set to RTBC. The full steps for that are at https://www.drupal.org/community/contributor-guide/task/review-a-merge-r....
Those steps are detailed and some may not apply to this issue. A key part is to comment on exactly what you did to review the issue. I know this is a 'simple' fix but it is a good habit to develop. As in, you read all the comments, or used some git command (--color-words would be useful here) or something else. And it is OK to not do everything part of a review. For example, I often review comments but not code and I say that clearly in my comments.
Comment #19
akmalfikri commentedI have read all the comments, walk through the changes, the MR is correct. Moving this into RTBC.
Note : Didn't do any code test as the changes are in the commented section of the code.
I've also updated the IS accordingly.
Comment #20
akmalfikri commentedComment #21
quietone commented@akmalfikri, Thanks for the detailed comment.
I review the MR and I agree that the change is correct and agrees with the issue summary and #11. I applied the diff to HEAD and got a screen full of 'error: patch failed' errors. Then I went back to the MR and saw that there are 1117 commits. Clearly, that is far too many for this small change. So, this now needs a rebase. Another check is that the diff file is 29MB!
There are instructions for rebasing a merge request in the Drupal Develop docs.
Comment #22
quietone commentedOops, the status should be 'needs work'.
Comment #23
suryantoI have finished rebase the merge request. There were no conflict during rebase.
Comment #24
quietone commented@suryanto, were there any conflicts or other problems with the rebase?
Comment #25
suryanto@quietone, there are no conflicts during rebase. Can we restore this issue as RTBC?
Comment #26
quietone commented@suryanto, yes. Especially true for this same change.
When there are no conflicts during a rebase one should state that in a comment, adding that is why it is being restored to RTBC. When there are conflicts it is best to state what they were so those files can be reviewed. However, we also know that some conflicts are simple and some are complex. So, the focus becomes commenting on what happened during the rebase so all contributors know what happened. It is OK to say things like 'there were conflicts in file X' and that should be reviewed. When reviewers know what to focus on, it saves us all time.
Comment #27
akmalfikri commentedAs per #25 there is no conflicts, and I have confirmed this. Moved back to RTBC.
Comment #28
suryantoThanks, @quietone, for the clarification and guidance.
I’ll make sure to include details about the rebase outcome in future. Whether there were no conflicts or which files had conflicts, so reviewers know what to look at.
Appreciate the feedback!
Comment #29
quietone commentedThanks everyone, this is ready to commit. Congratulations!
And remember that issues tagged 'Novice' are for Drupal first time contributors. As you gain experience with the contribution process you should move to other issues.
I am assigning this to myself to commit. Actually, I am trying to do that now but I am having trouble with composer in DDEV.
Comment #33
quietone commentedI didn't realize I had xdebug enabled on my environment for only core committing.
Committed to 11.x and cherry-pick 11.3.x and 11.2.x.
Thanks!
Comment #35
quietone commentedAdding to parent issue for fixing broken URLs