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

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

phpsubbarao created an issue. See original summary.

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Status: Active » Needs review

Committed according to the proposed solution.

Please review it!.

Bushra Shaikh’s picture

StatusFileSize
new38.55 KB

I verified and applied MR !2 for Drupal version 10.0.2.
README.txt file updated to README.md after applying this patch. But got warning
Adding screenshots for reference.

2.diff.patch:121: trailing whitespace.
- Shaun Musick (Shawn2516) - https://www.drupal.org/u/shawn2516
warning: 1 line adds whitespace errors.

Manoj Raj.R’s picture

Status: Needs review » Needs work

i will work on it.

Manoj Raj.R’s picture

Status: Needs work » Needs review

Updated with latest changes.

Please review.

clarkssquared’s picture

Status: Needs review » Needs work
StatusFileSize
new133.9 KB
new22.14 KB
new322.55 KB

Hi Manoj Raj.R

I applied your updated MR !2 to my local and confirmed that the MR applies cleanly without any whitespace error and replaced the README.txt file to README.md. But I have concern.

In this line
## Installation

Views Add Button installs like most Drupal modules:
https://www.drupal.org/docs/extending-drupal/installing-modules

I believe that it means "Install Views Add Button like most Drupal modules:"

Kindly check please,
Thank you

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
nitin_lama’s picture

Status: Needs work » Needs review

Please review.

nitin_lama’s picture

Assigned: nitin_lama » Unassigned
clarkssquared’s picture

Status: Needs review » Needs work
StatusFileSize
new22.92 KB
new304.22 KB

Hi nitin_lama

I applied the updated MR !2 in freshly installed Views Add Button module and confirmed that the README content is now good, but the file doesn't change from .txt to .md file

Please look at the screenshot attached for your reference

Thank you

laboratory.mike made their first commit to this issue’s fork.

laboratory.mike’s picture

laboratory.mike’s picture

@manoj-rajr it looks great, thanks.

I've merged it in, and will include in 2.0.5 .

laboratory.mike’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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