Replace README.txt with README.md and update README.md file

Created on 15 February 2023, almost 2 years ago
Updated 22 September 2023, about 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.

Follow the pattern in the README.md template .

📌 Task
Status

Needs work

Version

1.0

Component

Documentation

Created by

🇮🇳India Charchil Khandelwal

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

Comments & Activities

  • Issue created by @Charchil Khandelwal
  • @charchil-khandelwal opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India Charchil Khandelwal

    Created MR for the issue, please review.

    Thanks.

  • Status changed to Needs work over 1 year ago
  • Tested the MR1 and got these warnings on applying the patch:

    readme.patch:22: trailing whitespace.
    Views PgwSlider module integrates the
    readme.patch:23: trailing whitespace.
    PgwSlider
    readme.patch:66: trailing whitespace.
    1. Download the 'Views PgwSlider' module archive. Extract and place it in the
    readme.patch:69: trailing whitespace.
    3. Download and extract the PgwSlider plugin and place it in libraries directory
    readme.patch:78: trailing whitespace.
    1. Create a new Content Type with an image field (set max of 1 image
    warning: squelched 2 whitespace errors
    warning: 7 lines add whitespace errors.

  • First commit to issue fork.
  • 🇮🇳India nitin_lama India

    "Ordered lists use "1", for easier updates and to avoid errors"

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

    The patch works fine. Moving it to RTBC

  • Status changed to Needs review over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    Since the last reviewer does not pay much attention to details, it would be better somebody else reviews the MR/patch.

  • 🇮🇳India Nupur Badola

    Reviewed MR!1, The patch is not cleanly applied.

    1. Change "## Contents of this file" to "## Table of contents".
    2. Change Number order to 1, 2, 3
    3. Configuration section is missing.
  • Assigned to nitin_lama
  • Issue was unassigned.
  • 🇮🇳India Nupur Badola

    Reviewed MR!1, the patch is not cleanly applied.

    git.drupalcode.org_project_views_pgwslider_-_merge_requests_1.diff.txt:114: trailing whitespace.
    +Views PgwSlider module integrates the
    git.drupalcode.org_project_views_pgwslider_-_merge_requests_1.diff.txt:115: trailing whitespace.
    +<a href="https://github.com/Pagawa/PgwSlider" target="_blank">PgwSlider</a>
    git.drupalcode.org_project_views_pgwslider_-_merge_requests_1.diff.txt:158: trailing whitespace.
    +1. Download the 'Views PgwSlider' module archive. Extract and place it in the
    git.drupalcode.org_project_views_pgwslider_-_merge_requests_1.diff.txt:161: trailing whitespace.
    +3. Download and extract the PgwSlider plugin and place it in libraries directory
    git.drupalcode.org_project_views_pgwslider_-_merge_requests_1.diff.txt:170: trailing whitespace.
    +1. Create a new Content Type with an image field (set max of 1 image
    warning: squelched 5 whitespace errors
    warning: 10 lines add whitespace errors.
    
    
    2. Change Number order to 1, 2, 3
    3. Configuration section is missing.
    
  • Status changed to Needs work about 1 year ago
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India nitin_lama India

    Changes are pushed to 8.x-1.x branch. MR as a patch will not apply as the changes are already there. Please review the file as per README.md template.

  • Status changed to Needs work about 1 year ago
  • As per the Drupal Readme.md template, configuration section is missing and also lists needs formatting.
    Changing Back to NW

  • Assigned to Priya_Degwekar
Production build 0.71.5 2024