Replace README.txt with README.md

Created on 11 November 2022, over 1 year ago
Updated 14 September 2023, 10 months ago

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

Follow this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

📌 Task
Status

RTBC

Version

2.0

Component

Documentation

Created by

🇮🇳India Pracheth

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇳India Nupur Badola

    File is not updated as per readme.md file template.
    1. [project page] and [issue queue] are missing.
    2. Requirements are missing.
    3. Format is not as per the readme.md file template.

  • Status changed to Needs work 10 months ago
  • 🇺🇸United States Greg Boggs Portland Oregon

    Thanks for the review Nupur, that's super helpful to get this one moving. If someone wants to work on this one a bit more, here's the listing of required sections for readme templates along with examples.

    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

  • First commit to issue fork.
  • Status changed to Needs review 10 months ago
  • Kindly review the changes

  • 🇺🇸United States Greg Boggs Portland Oregon

    Looks like a great start. Lets keep the recommended modules section that describes the two related modules

    ## Recommended modules (optional)
    

    and lets also keep the link to MailChimp's documentation because it's super helpful to describe the softwares.

  • Assigned to thakurnishant_06
  • Status changed to Needs work 10 months ago
  • Hello Greg,
    Thanks for the review , i will work on the suggested changes.

  • Issue was unassigned.
  • Status changed to Needs review 10 months ago
  • Status changed to Needs work 10 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi thakurnishant_06

    I applied and reviewed your MR and the recommended modules don't follow the README.md template.

    [Markdown filter](https://www.drupal.org/project/markdown): When enabled,
    display of the project's README.md help will be rendered with markdown.

    Also you only added one recommended module, and also you didn't add a link to MailChimp's documentation as per comment #9.

    Please look at the screenshot I attached for your reference

    Thank you

  • Assigned to nitin_lama
  • Issue was unassigned.
  • Status changed to Needs review 10 months ago
  • Status changed to RTBC 10 months ago
  • 🇺🇸United States Greg Boggs Portland Oregon

    I added the link to Mailchimp documentation and I think this is ready to commit, a nice improvement over the old file with extra details for folks who are brand new to Drupal.

Production build 0.69.0 2024