Change all README.txt files to README.md

This was done in #3192842: Make our README more welcoming by converting it into an "entrypoint" into the Drupal ecosystem → , but only for the main README.txt. I am reopening this as a follow-up to discuss/convert all other READMEs. See: #3389611-17: Update robots.txt with all README files core ships with →

The last patch needs to be updated - I think it will be the best to focus only on README files here (as the IS suggested initially). Thanks!

I am agree with @poker10
The ticker is only for README.txt to README.md conversion but i saw that may files are updating which are not readme files. So only README files should update otherwise we will face broken deployment merge.

Hey,

Here is the patch! Let me know any adjustment needed! Thanks

The Needs Review Queue Bot → tested this issue.

While you are making the above changes, we recommend that you convert this patch to a merge request → . Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other contributions to the issue will not receive credit.)

I am at DrupalCon working on getting this patch in 22 to be applyable.

I'm jumping on this issue as part of the mentored contribution at Drupalcon 24!

I am working on this issue as part of Mentored Contribution at Drupalcon 24!

I'm mentoring our table on this issue. So far there's @skessler, @koppie and @Chibullz023 working on this. We will create a MR but for now are focused on reviewing and updating the patch.

Note that we've been trying to update the patch from #22 to work with the latest 11.x code. One person in the group will start from scratch and not use the old patch. Once we have something to upload, we will. Then we will create the MR.

Rolled a new patch. Removed changes to composer.lock and other composer files.

Rerolled patch without /web

Third time is the charm.

That patch applied cleanly to 11.x when I did:

git apply --index -v Fixes-for-Drupal-3044974_2.patch

but not with patch -p1.

Afterwards, I do get some remaining README.txt files:

./core/lib/Drupal/Component/Discovery/README.txt
./core/lib/Drupal/Component/Plugin/README.txt
./core/lib/Drupal/Component/Assertion/README.txt
./core/lib/Drupal/Component/DependencyInjection/README.txt
./core/profiles/demo_umami/themes/umami/images/classy/README.txt
./core/profiles/demo_umami/themes/umami/js/classy/README.txt
./core/modules/system/tests/src/Functional/UpdateSystem/README.txt
./composer/Metapackage/README.txt
./composer/Plugin/VendorHardening/README.txt
./composer/Template/README.txt
./sites/README.txt
./profiles/README.txt
./modules/README.txt
./themes/README.txt

and see it in some files:

./composer.lock:                        "[web-root]/sites/README.txt": "assets/scaffold/files/sites.README.txt",
./composer.lock:                        "[web-root]/modules/README.txt": "assets/scaffold/files/modules.README.txt",
./composer.lock:                        "[web-root]/profiles/README.txt": "assets/scaffold/files/profiles.README.txt",
./composer.lock:                        "[web-root]/themes/README.txt": "assets/scaffold/files/themes.README.txt"
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Metapackage/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Template/README.txt
./composer/Generator/BuilderInterface.php: * See the README.txt file in composer/Metapackage for a description of what
./robots.txt:Disallow: /composer/Metapackage/README.txt
./robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./robots.txt:Disallow: /composer/Template/README.txt

This patch covers the changes above and adds the composer folder. The composer folder is only found when cloning the git directory rather than downloading with composer.

Applies cleanly with git apply --index -v 3044974_patch_from_git.patch.

Did still notice the following but there are no README.txt files left.

./composer.lock:                        "[web-root]/sites/README.txt": "assets/scaffold/files/sites.README.txt",
./composer.lock:                        "[web-root]/modules/README.txt": "assets/scaffold/files/modules.README.txt",
./composer.lock:                        "[web-root]/profiles/README.txt": "assets/scaffold/files/profiles.README.txt",
./composer.lock:                        "[web-root]/themes/README.txt": "assets/scaffold/files/themes.README.txt"
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Metapackage/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Template/README.txt

The patch applies cleanly! However, I noticed one remaining issue: modules/README.txt gets deleted. Was that intentional?

I'm keeping this marked as "needs work" until this last issue gets resolved.

I'm uploading my own version of the patch with only one change: rename modules/README.txt to modules/README.md, instead of deleting it. Please test.

Can we change to an MR please.

@smustgrave We will be once we have the patch working as noted above.

This new patch should cover all the issues.
Thank you for the reviews and feedback.

Thanks @koppie and @skessler :) I'll review and if it's good or close, I'll get it moved to an MR. I know you both are heading out now.

@skessler I'm still seeing below but other issues do seem to be fixed.

@smustgrave Please note that @skessler is hoping to move this to an MR as a learning opportunity over the next couple days.

Kristens-MacBook-Pro:drupal11 kristenpol$ grep -r README.txt .|more
./composer.lock:                        "[web-root]/sites/README.txt": "assets/scaffold/files/sites.README.txt",
./composer.lock:                        "[web-root]/modules/README.txt": "assets/scaffold/files/modules.README.txt",
./composer.lock:                        "[web-root]/profiles/README.txt": "assets/scaffold/files/profiles.README.txt",
./composer.lock:                        "[web-root]/themes/README.txt": "assets/scaffold/files/themes.README.txt"
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Metapackage/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Template/README.txt

Whoops, @skessler's latest version still deletes modules/README.txt. Here's a new version that renames instead of deletes. @kristen-pol I'll let you create the MR since I've never done that in the context of d.org. :-)

It's getting there :)

@koppie If you are able, I'm seeing these still in #44.

Kristens-MacBook-Pro:drupal11 kristenpol$ grep -r README.txt .|more
./composer.lock:                        "[web-root]/sites/README.txt": "assets/scaffold/files/sites.README.txt",
./composer.lock:                        "[web-root]/modules/README.txt": "assets/scaffold/files/modules.README.txt",
./composer.lock:                        "[web-root]/profiles/README.txt": "assets/scaffold/files/profiles.README.txt",
./composer.lock:                        "[web-root]/themes/README.txt": "assets/scaffold/files/themes.README.txt"
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Metapackage/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./core/assets/scaffold/files/robots.txt:Disallow: /composer/Template/README.txt
./composer/Generator/BuilderInterface.php: * See the README.txt file in composer/Metapackage for a description of what
./robots.txt:Disallow: /composer/Metapackage/README.txt
./robots.txt:Disallow: /composer/Plugin/VendorHardening/README.txt
./robots.txt:Disallow: /composer/Template/README.txt

Thanks @kristen-pol, I've gone through one more time to find any remaining references to README.txt in the code base, and I think I've got them all. Please test.

Thanks @koppie and @kristen-pol, for your help. I think I uploaded the wrong file last time because I know I made those changes.

Thanks,
Steve

Just re-tagging with the official tag :-)

@rachel_norfolk Thanks! Looks like you (or someone) fixed all the others too :)

@skessler if you have time soon, please review the patch from @koppie and, if it looks good, create an MR. Then we can get this issue moved forward.

Since it's been a few days going to move to NW for the MR.

Leaving all tags as this should still be reserved for those who worked on it in Portland

This may help too https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-dr... →

@skessler asked for help to change this into an MR via slack a few days ago but I’m traveling and unable to help.

@smustgrave you have any availability to help on mentoring?

Ready for review: https://git.drupalcode.org/project/drupal/-/merge_requests/8115

It seems that simply changing the extension doesn't preserve the good formatting for md files. I think they need to be updated to the correct formatting for code, tables, links, etc. This will further improve the visual perception and usability

Maks,

The plan had been to make these changes and then open a new ticket to make all of the changes in the files to include Markdown. I am fine either way. It is going to take me a bit to get all the Markdown changes made.

Thoughts?

Thanks,
Steve

Leaving novice tag for those who worked on in Portland. Can the MR be rebased? appears to have test failures

@smustgrave, sorry for the basic question but I am trying to do the rebase I cannot find the correct name for the remote branch. I would think it should be origin/issue-3044974 but my local git client is reporting that the branch does not exist.

Thank you for the help.

Thanks,
Steve

@skessler, Just after the Issue Summary there is a 'show commands' link which while display information about the fork and branch. And, there is a how to for rebasing a merge request → as well. Linking that in case you need it. I hope that helps.

Thanks @quietone

I'm also available on slack in #contribute or #first-contribution to further help.

I am not sure what happened here but I was sure I had posted an update.
The issue with the merge request is that we are trying to change the composer.lock. At some point the composer.lock file needs to change but I think this should happen the next time Composer is run for Drupal Core. I am not sure what this process is. But the hashes in composer.lock are changing so this means that Composer is updating composer.lock at some point.

Thoughts about leaving out composer.lock from the MR?

Thanks,
Steve

@skessler, thank for continue to wok on this. This issue should just be making changed related to the .txt file and should not be touching the composer.lock file. I suggested reverting that change and rebasing on 11.x. Good luck!

I am starting to work on this issue.

Just hiding the old patch files from the issue summary to make the current target clearer. :)

The issue in the composer.lock file has been fixed (leftover from earlier merge conflicts), the branch has been rebased to the latest version of 11.x and the composer.lock file (hashes) has been updated.

This has been done with the help from Jess (@xjm), @stefdewa and Randy Fay.
More information on updating the composer.lock inside core can be found on https://www.drupal.org/about/core/policies/core-dependency-policies-and-practices/managing-composer-updates-for-drupal-core → .

Seems one has been missed for recipes.README.txt

Leaving the novice tag

Discussed with grietdk IRL.
Renamed recipes.README.txt to recipes.README.md (and updated composer.lock hash).

LGTM

There's an unintended side-effect of this
Some of these files are actually part of the composer scaffold API.

E.g. https://www.drupal.org/docs/develop/using-composer/using-drupals-compose... →

If we move them, people who are making use of this plugin and referencing the old files will lose that functionality - e.g. this change here

Eg if someone has this in their composer.json

"drupal-scaffold": {
            "file-mapping": {
                "[web-root]/modules/README.txt": false,
            },
            "locations": {
                "web-root": "docroot/"
            }
        },

After this change, they will get a README.md in that place.

We'll need to think about how to handle this in a BC way.