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
#2 3321561-2.patch2.34 KBPracheth

Issue fork miniorange_saml-3321561

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

phpsubbarao created an issue. See original summary.

Pracheth’s picture

Pracheth commented
Status: Active » Needs review
StatusFileSize
new 3321561-2.patch2.34 KB

Updated README.txt to README.md as per Drupal markdown practices and also added a maintainers section with their info.
Please review the same.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work

@Pracheth

Can we use the Markdown for LINK also.

Also it would be great if you can create a merge request with a branch.

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

sahil.goyal made their first commit to this issue’s fork.

sahil.goyal opened merge request !1

sahil.goyal’s picture

sahil.goyal commented
Status: Needs work » Needs review
Issue tags: +Replace README.txt with README.md

replaced Readme.txt with readme.md file as per following markdown documenting template structure. Created MR, Please Review

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work
Manoj Raj.R’s picture

Manoj Raj.R commented

Updated with some formatting readme format.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Please review

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review
shrishail hiremath’s picture

shrishail hiremath
he/him
Primary language English
commented
Version: 8.x-2.27 » 3.0.4
Assigned: Unassigned » shrishail hiremath
Status: Needs review » Fixed

This has been fixed.

shrishail hiremath’s picture

shrishail hiremath
he/him
Primary language English
commented
Status: Fixed » Closed (fixed)