Replace README.txt with README.md

Created on 24 January 2023, over 1 year ago
Updated 30 October 2023, 8 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 Sonal Gyanani

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

Comments & Activities

  • Issue created by @Sonal Gyanani
  • @sonal-gyanani opened merge request.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Sonal Gyanani

    Created MR for the issue.
    Please review.
    Thanks

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Issue with the patch.

    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.patch.txt:22: trailing whitespace.
    Users fill in their email, amount, and that's all. This uses the Paystack
    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.patch.txt:59: trailing whitespace.
    *Note:* The donate link is also configurable. Do not forget to flush your cache
    error: patch failed: README.txt:1
    error: README.txt: patch does not apply
    
  • Status changed to Needs work 12 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Sonal Gyanani

    I applied and reviewed your MR and confirmed that it replaced README.txt with README.md, but it doesn't follow README.md template โ†’ and has a missing information for maintainer. Please see the screenshots attached.

    Thank you.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 12 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Changes to the readme.md file. Kindly review the changes.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

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

    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.diff.txt:10: trailing whitespace.
    Users fill in their email, amount, and that's all. This module utilizes the
    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.diff.txt:11: trailing whitespace.
    [Paystack inline API](https://paystack.com/docs/) allowing donations to be
    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.diff.txt:14: trailing whitespace.
    - For a full description of the module, please visit the
    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.diff.txt:17: trailing whitespace.
    - To submit bug reports, feature suggestions, or track changes, visit the
    git.drupalcode.org_project_paystack_donate_-_merge_requests_1.diff.txt:36: trailing whitespace.
    Install the Paystack Donate module as you would normally install a contributed Drupal module. For further information, visit
    error: patch failed: README.txt:1
    error: README.txt: patch does not apply
    

    Hence unable to verify the readme.md file format as patch is not applied.

  • Status changed to Needs work 9 months ago
  • First commit to issue fork.
  • Status changed to Needs review 8 months ago
  • ๐Ÿ‡ง๐Ÿ‡ชBelgium Frederikvho Belgium
  • Status changed to Needs work 8 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patch is not cleanly applied.
    1. "## Contents" should changed to "## Table of contents".
    Please update readme.md file as per readme.md file template. Please refer https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

  • Status changed to Needs review 8 months ago
  • ๐Ÿ‡ง๐Ÿ‡ชBelgium Frederikvho Belgium

    I missed that, sorry. Fixed in latest commit. Please re-review the MR. Kind regards

  • Status changed to RTBC 8 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the file is updated as per the readme.md file template. Hence marking it to RTBC.

Production build 0.69.0 2024