Follow-up to #3303727: Document in README how to add paths to composer.json:extra.drupal-core-vendor-hardening to avoid symlink errors

Per https://drupal.slack.com/archives/C7QJNEY3E/p1661177997152989...

If a user sees the validation message, "Symbolic links were found in the active directory, which are not supported at this time," they may just stop there.

Add a link to the validation message to the module a hook_help page from Package Manager that explains how to deal symlinks.

CommentFileSizeAuthor
#7 status-report.png186.3 KBtraviscarden
#7 help-page.png484.22 KBtraviscarden
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

TravisCarden created an issue. See original summary.

traviscarden’s picture

Title: Move symlink FAQ from root README to package_manager » Add a link to the the symlink validation message in package_manager to the module README.md
traviscarden’s picture

@tedbow, I know we said we would link to the REAME to avoid duplication, but I notice we already have a help page that duplicates it--and is out-of-sync. So linking to the README would actually introduce inconsistency on top of the duplication and brokenness that already exists. I wonder if we should first reconsider our general approach to documentation and linking to it.

traviscarden’s picture

Assigned: traviscarden » Unassigned
tedbow’s picture

Issue summary: View changes

@TravisCarden just updating this issue.

traviscarden’s picture

Title: Add a link to the the symlink validation message in package_manager to the module README.md » Add a link to the the symlink validation message in package_manager to the updated help page
Status: Active » Needs review
StatusFileSize
new484.22 KB
new186.3 KB

Ready for your review @tedbow. Would you like any kind of tests?

Here's the status report page showing the updated error:

Status report

And here's the updated help page:

Help page

tedbow’s picture

Status: Needs review » Needs work
Issue tags: +Needs tests

Nice, I like having this in the help pages.

I put an idea for a test on the merge request.

traviscarden’s picture

Status: Needs work » Needs review
tedbow’s picture

Status: Needs review » Needs work

for MR comment

tedbow’s picture

Status: Needs work » Reviewed & tested by the community

Looks great! Good to have the hook_help expanded! Thanks @TravisCarden

Will merge on green

  • tedbow committed 0f8f497 on 8.x-2.x authored by TravisCarden
    Issue #3305240 by TravisCarden: Add a link to the the symlink validation...
tedbow’s picture

Status: Reviewed & tested by the community » Fixed
Issue tags: -Needs tests

🎉

Status: Fixed » Closed (fixed)

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

tedbow’s picture

Issue tags: +core-mvp