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

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

Manoj Raj.R created an issue. See original summary.

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

immaculatexavier’s picture

Status: Active » Needs review

Committed in accordance to the stated requirement

Manoj Raj.R’s picture

@immaculatexavier
I was wondering how to make this changes.
Could you please provide steps how your proposing your solution.

elber’s picture

Hi @Manoj Raj.R I think you just need to rename the README.txt file to README.md.

But if you want a pattern of READMEs files in Drupal, please see the link below:

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Manoj Raj.R’s picture

@elber
I clearly understood how we can rename the README.txt to README.md which to probably use Markdown behavior for future purposes.

Just got idea on this :
https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa...

Manoj Raj.R’s picture

Committed with proper Installation Notes.

emarinho’s picture

Assigned: Unassigned » emarinho

I'll review it!

emarinho’s picture

Assigned: emarinho » Unassigned
Status: Needs review » Reviewed & tested by the community

Everything is okay!!

damienmckenna’s picture

Status: Reviewed & tested by the community » Needs work

The file needs more work beyond renaming the file - the headings and links should be changed to Markdown syntax, etc.

emarinho’s picture

Assigned: Unassigned » emarinho

Ok! Thanks, @DamienMcKenna! I'll work on it!

Manoj Raj.R’s picture

Status: Needs work » Needs review
emarinho’s picture

Status: Needs review » Needs work

Hi, @Manoj Raj.R! Your commit still need some work. I'll fix those that are left. Also, please, double check before working in a issue if someone already assigned to it to avoid re-working.

emarinho’s picture

Assigned: emarinho » Unassigned
Status: Needs work » Needs review

Here comes some changes. Please, kindly review it. :)

erikaagp’s picture

Status: Needs review » Reviewed & tested by the community

the changes look good for me. Let's see if it's approved by the mantainers, or if needs more work to keep working on it. :)

Nila Hyalij’s picture

changes looks good for me

avpaderno’s picture

The Drupal coding standards, under Naming Conventions / File names, says:

All documentation files should have the file name extension ".txt" to make viewing them on Windows systems easier. Also, the file names for such files should be all-caps (e.g. README.txt instead of readme.txt) while the extension itself is all-lowercase (i.e. txt instead of TXT).

damienmckenna’s picture

@apderno: That seems to be out of date and misses the point of the newer Markdown syntax files that Gitlab supports; I updated the docs page to reference the newer standard.

avpaderno’s picture

@DamienMcKenna It could be outdated, but until #3012906: Add Markdown to list of module documentation file types isn't closed, that is what the coding standards say.

damienmckenna’s picture

Core already set the standard by converting to a Markdown file (#3192842: Make our README more welcoming by converting it into an "entrypoint" into the Drupal ecosystem). But we're going off-tangent here.

grimreaper’s picture

Assigned: Unassigned » grimreaper

  • Grimreaper committed 25863e9f on 8.x-1.x
    Issue #3313843 by Manoj Raj.R, Grimreaper: Replace README.txt with...
grimreaper’s picture

Assigned: grimreaper » Unassigned
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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