Problem/Motivation

In #3192842: Make our README more welcoming by converting it into an "entrypoint" into the Drupal ecosystem the README.txt in the Drupal root directory was renamed to README.md. But there are references in other READMEs to this old file. We should update these references to point to the correct filename.

1. https://git.drupalcode.org/project/drupal/-/blob/11.x/themes/README.txt?...

Refer to the "Appearance" section of the README.txt in the Drupal root directory

2. https://git.drupalcode.org/project/drupal/-/blob/11.x/profiles/README.tx...

Refer to the "Installation profiles" section of the README.txt in the Drupal root directory

3. https://git.drupalcode.org/project/drupal/-/blob/11.x/modules/README.txt...

Refer to the “Developing for Drupal” section of the README.txt in the Drupal root directory

Steps to reproduce

See the 3 files:

themes/README.txt
profiles/README.txt
modules/README.txt

These are referring to /README.txt instead of /README.md.

Proposed resolution

Fix the names.

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

Issue fork drupal-3391137

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:

About issue forks

Comments

poker10 created an issue. See original summary.

poker10 opened merge request !4920

poker10’s picture

poker10 commented
Status: Active » Needs review
Related issues: +#3192842: Make our README more welcoming by converting it into an "entrypoint" into the Drupal ecosystem
smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Good catch.

Did a search for README.txt and found a 20+ other instances but they all seem to refer to actual .txt files. Maybe follow up is to convert the others to .md? Unless that was discussed already.

poker10’s picture

poker10 commented

@smustgrave Yes, this was also suggested by @xjm in #3389611: Update robots.txt with all README files core ships with, so I have reopened this older issue: #3044974: Change all README.txt files to README.md

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Version: 11.x-dev » 10.1.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed 9d83a203d14 to 11.x and 27a4abe3e87 to 10.1.x. Thanks!

  • alexpott committed 9d83a203 on 11.x 
    Issue #3391137 by poker10: Change references to README.txt in root...

  • alexpott committed 27a4abe3 on 10.1.x 
    Issue #3391137 by poker10: Change references to README.txt in root...

Status: Fixed » Closed (fixed)

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