Replace README.txt with README.md

Created on 16 November 2022, about 2 years ago
Updated 11 August 2023, over 1 year 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.

📌 Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

🇮🇳India panwarjatin

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 Bushra Shaikh

    I verified and applied Patch #2 for Drupal version 10.0.2.
    README.txt file updated to README.md after applying this patch.
    Adding screenshots for reference.

    Can be moved to RTBC +1

  • Status changed to Needs work over 1 year ago
  • 🇮🇳India kavitha@specbee.com

    While applying patch, getting the below message:

    patch:16: trailing whitespace.
    * Ravikant Mane (ravimane23) - https://www.drupal.org/u/ravimane23 →
    warning: 1 line adds whitespace errors.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India mrinalini9 New Delhi

    Updated patch #2 by addressing #4, please review it.

    Thanks & Regards,
    Mrinalini

  • First commit to issue fork.
  • Status changed to Needs work over 1 year ago
  • 🇵🇭Philippines clarkssquared

    Hi mrinalini9

    I applied your patch #6 and I confirm that your patch successfully replaced README.txt file to README.md. However, the content inside the README.md file seems to be incomplete according to README.md Drupal Format → for your convenience, below is the README.md sections according to Drupal.

    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)

    Please look at the screenshot I attached for your reference

    Thank you

  • 🇧🇪Belgium Frederikvho Belgium

    Hi,

    I had the same remarks as #7 and had already pushed fixes to the forked branch.

    However, I believe something went wrong creating the fork like I normally do and I was unable to create a merge request for it.

    I will try to recreate it in a few hours.

  • @frederikvho opened merge request.
  • Status changed to Needs review over 1 year ago
  • 🇧🇪Belgium Frederikvho Belgium

    Hi,

    As stated in the previous comments, the required paragraphs were added to the README.md file in an issue fork.
    Please review the merge request. Thanks!

  • 🇮🇳India Nupur Badola

    Reviewed Patch, The Patch is not as per the readme.md file template.

    visible content is:-
    # Webform Submissions Download
    
    ## INSTALLATION
    
    Install as you would normally install a contributed Drupal module. Visit:
    https://www.drupal.org/node/1897420 for further information.
    
    ## MAINTAINERS
    
    * Ravikant Mane (ravimane23) - https://www.drupal.org/u/ravimane23
    

    However according to readme.md file template, it should be like this:-

    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)
  • 🇧🇪Belgium Frederikvho Belgium

    Hi @Nupur Badola,

    You seem to be repeating comment #7

    Please take a look at the more recent merge request.
    As I mentioned in comment #10 the required README.md paragraphs were added in the issue fork.

    If you still think the issue needs work, please change the label to 'Needs work'.

  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • First commit to issue fork.
  • Status changed to Needs review over 1 year ago
  • Status changed to Fixed over 1 year ago
  • 🇮🇳India ravimane23

    Thank you all for your help.
    Merge request is approved and code is merged.

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

Production build 0.71.5 2024