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

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

mortona2k created an issue. See original summary.

quietone’s picture

Version: 11.1.x-dev » 11.x-dev
arunsahijpal’s picture

Working on it.

mortona2k’s picture

Is the info still relevant? I'm not sure if it's documented anywhere else.

arunsahijpal’s picture

Status: Active » Needs review

Hi @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.

smustgrave’s picture

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

Think some replacement may be needed vs just removing, but IS is incomplete.

quietone’s picture

Status: Needs work » Needs review

Having 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.

smustgrave’s picture

Priority: Normal » Minor
Status: Needs review » Needs work

Fair enough, but for good practice think the issue summary should still be complete

smustgrave’s picture

xjm’s picture

Issue tags: +Vienna2025

I 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!

oily’s picture

Issue summary: View changes
Issue tags: -Needs issue summary update

Applied IS template, minimal removal and re-write of IS, updated the Remaining tasks.

oily’s picture

Issue summary: View changes
quietone’s picture

Issue summary: View changes
Issue tags: +Novice
quietone’s picture

Title: Fix broken link in MenuTreeStorageInterface » Remove broken link in MenuTreeStorageInterface

After questions in Slack, I am changing the title to be explicit.

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

suryanto’s picture

Status: Needs work » Needs review
Issue tags: -Vienna2025

I’ve reverted the text copy to the previous version and removed the dead link. I’ve implemented the change requested in #11.

quietone’s picture

Issue summary: View changes

@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.

akmalfikri’s picture

Status: Needs review » Reviewed & tested by the community

I 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.

akmalfikri’s picture

Issue summary: View changes
quietone’s picture

Issue summary: View changes

@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.

quietone’s picture

Status: Reviewed & tested by the community » Needs work

Oops, the status should be 'needs work'.

suryanto’s picture

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

I have finished rebase the merge request. There were no conflict during rebase.

quietone’s picture

@suryanto, were there any conflicts or other problems with the rebase?

suryanto’s picture

@quietone, there are no conflicts during rebase. Can we restore this issue as RTBC?

quietone’s picture

@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.

akmalfikri’s picture

Status: Needs review » Reviewed & tested by the community

As per #25 there is no conflicts, and I have confirmed this. Moved back to RTBC.

suryanto’s picture

Thanks, @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!

quietone’s picture

Assigned: Unassigned » quietone

Thanks 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.

  • quietone committed 44b56f10 on 11.x
    docs: #3517609 Remove broken link in MenuTreeStorageInterface
    
    By:...

  • quietone committed 83030b63 on 11.3.x
    docs: #3517609 Remove broken link in MenuTreeStorageInterface
    
    By:...

  • quietone committed b1c65e27 on 11.2.x
    docs: #3517609 Remove broken link in MenuTreeStorageInterface
    
    By:...
quietone’s picture

Assigned: quietone » Unassigned
Status: Reviewed & tested by the community » Fixed

I 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!

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.

quietone’s picture

Adding to parent issue for fixing broken URLs

Status: Fixed » Closed (fixed)

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