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

CommentFileSizeAuthor
#5 3339451-4.patch2.26 KBrinku jacob 13
#4 3339451-4.patch2.26 KBrinku jacob 13

Issue fork experience-3339451

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:

About issue forks

Comments

gowthami reddy created an issue. See original summary.

gowthami reddy’s picture

gowthami reddy commented
Status: Active » Needs review

As per md format updated the readme file

Please review it!

Rinku Jacob 13 opened merge request !2

rinku jacob 13’s picture

rinku jacob 13 commented
StatusFileSize
new 3339451-4.patch2.26 KB

Updated some changes on README.md file. Please Review it.

rinku jacob 13’s picture

rinku jacob 13 commented
StatusFileSize
new 3339451-4.patch2.26 KB

Rinku Jacob 13 opened merge request !3

Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Unassigned » Sonal Gyanani
Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Sonal Gyanani » Unassigned

Hi @Rinku Jacob 13, please close mr 3.

Rinku Jacob 13 closed merge request !3

hardikpandya made their first commit to this issue’s fork.

nupur badola’s picture

nupur badola commented

There are some issues in thee patch.

2.diff.txt:38: trailing whitespace.
Install as you would normally install a contributed Drupal module.See
warning: 1 line adds whitespace errors.
nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

ravi kant changed the visibility of the branch 3339451-update-readme.md to hidden.

ravi kant’s picture

ravi kant commented
Status: Needs work » Needs review

I have updated MR!2.

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community

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

balajidharma’s picture

balajidharma
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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