Change README.txt to README.md and update contents

Created on 5 April 2024, 9 months ago
Updated 4 July 2024, 6 months ago

Problem/Motivation

Change README.txt to README.md and update contents.

It's not enough to change the file, the contents also need to be perfect ;) (No credits otherwise!)

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

RTBC

Version

10.0

Component

Documentation

Created by

🇩🇪Germany Anybody Porta Westfalica

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @Anybody
  • First commit to issue fork.
  • Merge request !11updated README.txt to README.md → (Open) created by Unnamed author
  • Status changed to Needs review 9 months ago
  • 🇮🇳India sarwan_verma

    Hi@Anybody,

    i have created MR please review it.

  • Pipeline finished with Success
    9 months ago
    Total: 135s
    #138614
  • 🇩🇪Germany Anybody Porta Westfalica

    Hi and thanks, please use this template: https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

    but leave out the maintainers section.

    Also I think it should be "Drupal 10+" instead of Drupal 8.

  • Status changed to Needs work 9 months ago
  • 🇩🇪Germany Anybody Porta Westfalica
  • First commit to issue fork.
  • Status changed to Needs review 8 months ago
  • 🇮🇳India deepak5423

    Hi @Anybody, I have updated the README.md file as per your comments.

  • Pipeline finished with Success
    8 months ago
    Total: 205s
    #176861
  • Status changed to Needs work 8 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi deepak5423

    I reviewed your changes, and as per comment #5 it should be using the README.md template , but your changes still not follows the template. Please add the required sections as per the README.md template with the correct format.

    Drupal recommends the following README sections:
    
    Project name and introduction (required)
    Table of contents (optional)
    Requirements (required)
    Recommended modules (optional)
    Installation (required, unless a separate INSTALL.md is provided)
    Configuration (required)
    Troubleshooting & FAQ (optional)
    Maintainers (optional)

    Thanks,
    Ken.

  • Status changed to Needs review 8 months ago
  • 🇮🇳India deepak5423

    @kenyoOwen @Anybody changes added please review.

  • Pipeline finished with Success
    8 months ago
    Total: 138s
    #180845
  • Status changed to Needs work 7 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi deepak5423

    I reviewed your changes and the # Front Page Module Module text should be removed, in that section please replace the This module is designed for Drupal 10+ with The Front Page module is designed for Drupal 10+ for better readability, and the "Introduction and Project name" section is missing a link to the project page and issue queue. The wrong format in the "Maintainer" section should be replaced with

    ## Maintainers
    
    - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
    - Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)

    Thanks,
    Ken.

  • Pipeline finished with Success
    7 months ago
    Total: 145s
    #191760
  • Status changed to Needs review 7 months ago
  • 🇮🇳India deepak5423

    Updated the README.md according to the standards.

  • Status changed to Needs work 7 months ago
  • 🇮🇳India dev16.addweb

    Thanks @deepak5423. We need to fix some issues, such as:

    modules/custom/front/README.md 
    
    FILE: /web/modules/custom/front/README.md
    ------------------------------------------------------------------------------------------------------
    FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
    ------------------------------------------------------------------------------------------------------
      3 | WARNING | Line exceeds 80 characters; contains 389 characters
     27 | WARNING | Line exceeds 80 characters; contains 97 characters
     28 | WARNING | Line exceeds 80 characters; contains 97 characters
     30 | WARNING | Line exceeds 80 characters; contains 151 characters
    ------------------------------------------------------------------------------------------------------
    
    Time: 51ms; Memory: 10MB
    
  • Status changed to Needs review 7 months ago
  • Pipeline finished with Success
    7 months ago
    Total: 137s
    #191788
  • Status changed to Needs work 7 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi silvi.addweb

    I reviewed your changes and I think the project page and issue queue numbering can be removed. The installation section should be replaced with

    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).

    and in configuration this should be removed 1. Install the module..

    Thanks

  • Pipeline finished with Success
    7 months ago
    Total: 169s
    #192660
  • Status changed to Needs review 7 months ago
  • 🇮🇳India vinmayiswamy

    Hi @ silvi.addweb ,

    I reviewed your changes and the changes are updated as suggested in #15 📌 Change README.txt to README.md and update contents Needs review .

    Thanks!

  • Status changed to RTBC 6 months ago
  • gaurav gupta Jaipur, Rajasthsan

    Hello
    I have tested the MR and Readme.md follows the template.
    Thanks

Production build 0.71.5 2024