Problem/Motivation

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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani’s picture

Assigned: Sonal Gyanani » Unassigned
Status: Active » Needs review

Created MR for the issue.
Please review.
Thanks

kenyoowen’s picture

Status: Needs review » Needs work
StatusFileSize
new426.7 KB
new86.51 KB
new452.17 KB

Hi Sonal Gyanani

I reviewed and apply your MR and the README.txt isn't replaced with README.md. And it also missing some information, please update it according to README.md template

Please see the screenshots attached.
Thank you.

nitin_lama’s picture

Assigned: Unassigned » nitin_lama
nitin_lama’s picture

Status: Needs work » Needs review

Addressed #4. Please review.

nitin_lama’s picture

Assigned: nitin_lama » Unassigned
kenyoowen’s picture

Status: Needs review » Needs work
StatusFileSize
new453.98 KB
new458.1 KB

Hi nitin_lama

I reviewed and applied your MR it follows the README.md template, but it didn't replaced README.txt with README.md. Please see the screenshots attached.

Thank you.

ravi kant’s picture

Status: Needs work » Needs review
StatusFileSize
new64.95 KB
new121.32 KB
new70.29 KB

@kenyoOwen
It is working for me.

before

patch applying

after

nupur badola’s picture

Status: Needs review » Reviewed & tested by the community

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

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

kyberman’s picture

Status: Reviewed & tested by the community » Fixed

Thank you very much! This is now merged to dev, and the new release is on the way.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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