Replace Readme.txt to README.md

Created on 2 May 2024, 7 months ago
Updated 16 July 2024, 4 months ago

Problem/Motivation

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation. So We need to use README.md instead of README.txt to make use of the nicer rendering via markdown.

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

📌 Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

🇮🇳India aadeshvermaster@gmail.com

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

Merge Requests

Comments & Activities

  • Status changed to Needs review 7 months ago
  • Hello, I have created a patch for readme.md file. Please review.
    Thank you!

  • Status changed to Needs work 6 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi arora.shivani

    I only reviewed your patch but not tested it. Introduction heading should be remove ## Introduction and add link to the project page and issue queue in the introduction section, since there are no outside modules Drupal core the requirements sections should be This module requires no modules outside of Drupal core., and installation section should be

    Install as you would normally install a contributed Drupal module. For further
    information, see
    [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).

    Thanks,
    Ken.

  • First commit to issue fork.
  • Status changed to Needs review 6 months ago
  • 🇮🇳India diwakar07

    Hi kenyoOwen,
    I have updated the README.md according to the changes suggested.
    Please review.

  • Status changed to Needs work 6 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I'm not sure what happened but, when I opened your MR!4 the README.md file rendered this text:
    File suppressed by a .gitattributes entry or the file's encoding is unsupported.

    Thanks,
    Ken.

  • Status changed to Needs review 6 months ago
  • 🇮🇳India diwakar07

    Hi @kenyoOwen,
    There was an issue with the encoding of the README.txt file.
    Deleted the README.txt file and created a new README.md file. Now the MR looks good.
    Please review.

  • Status changed to Needs work 6 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I reviewed the MR!4 and the table of content (TOC) isn't following the format

    ## Table of Contents
    
    - [Requirements](#requirements)
    - [Recommended Modules](#recommended-modules)
    - [Installation](#installation)
    - [Configuration](#configuration)
    - [Troubleshooting & FAQ](#troubleshooting--faq)

    README format

    ## Table of contents
    
    - Requirements
    - Recommended modules
    - Installation
    - Configuration
    - Troubleshooting
    - FAQ
    - Maintainers

    Also as per README TOCs are optional but appreciated for lengthy README files. You can either remove or change the format of the TOC of the module.

    Thanks

  • Status changed to Needs review 6 months ago
  • 🇮🇳India diwakar07

    Hi,
    I have updated the MR accordingly. Please review.

  • Status changed to Needs work 5 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I reviewed your changes and it didn't fix the comment #9. The only issue that wasn't fixed was the TOC name. The README.md TOC name is ## Table of contents while in your MR the name of it is ## Table of Contents, "contents" should be a small letter.

    Thanks.

  • Status changed to Needs review 4 months ago
  • 🇮🇳India diwakar07

    Please review.

  • Status changed to RTBC 4 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Diwakar07

    I reviewed your changes and it fixed the comment #11. README.md file is now following the README.md template.
    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... →

    Thanks

Production build 0.71.5 2024