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

CommentFileSizeAuthor
#8 Paragraphs_readme.PNG32.98 KBkavitha89
#4 3339435 - after.png297.58 KBkenyoowen
#4 3339435 - before.png68.83 KBkenyoowen

Issue fork paragraphs_modal_edit-3339435

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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani opened merge request !3

Sonal Gyanani’s picture

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

Created MR for the issue.
Please review.
Thanks

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work
StatusFileSize
new 3339435 - before.png68.83 KB
new 3339435 - after.png297.58 KB

Hi Sonal Gyanani

I applied and review 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

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama

Hi @kenyoOwen, I do not see the README.txt file in the after screenshot you provided. I've switched to 3339435-replace-readme.txt-with branch and README.txt has been replaced. Updating README.md as per README.md template.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Status: Needs work » Needs review
nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned
kavitha89’s picture

kavitha89 commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Paragraphs_readme.PNG32.98 KB

The patch works fine and moving it to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Priority: Normal » Minor
Status: Reviewed & tested by the community » Needs work
nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama
nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned
Status: Needs work » Needs review
nupur badola’s picture

nupur badola commented

Reviewed MR!3, the patch is not cleanly applied.
1. Two lines prior to ##/### headings which is missing prior to Table of contents and Requirement section.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama
zkhan.aamir’s picture

zkhan.aamir commented
Assigned: nitin_lama » zkhan.aamir
zkhan.aamir’s picture

zkhan.aamir commented
zkhan.aamir’s picture

zkhan.aamir commented

zkhan.aamir opened merge request !4

zkhan.aamir’s picture

zkhan.aamir commented
Assigned: zkhan.aamir » Unassigned

zkhan.aamir closed merge request !4

nupur badola’s picture

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

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

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work
zkhan.aamir’s picture

zkhan.aamir commented
Assigned: Unassigned » zkhan.aamir
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented

That is a comma-splice sentence: sentences joined with a comma. Those are independent sentences; there must be a period at the end of each of them.

zkhan.aamir’s picture

zkhan.aamir commented
Status: Needs work » Needs review
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Needs review » Needs work

Anjali Mehta made their first commit to this issue’s fork.

anjali mehta’s picture

anjali mehta commented
Status: Needs work » Needs review
kenyoowen’s picture

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

Hi Anjali Mehta

I reviewed your changes and it resolves the issue mentioned in comment #25 which is removing the forward slash in the introduction sentence.

Thank you

zkhan.aamir’s picture

zkhan.aamir commented
Assigned: zkhan.aamir » Unassigned
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work
zkhan.aamir’s picture

zkhan.aamir commented
Status: Needs work » Needs review
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Needs review » Reviewed & tested by the community

smustgrave closed merge request !3

smustgrave’s picture

smustgrave commented
Status: Reviewed & tested by the community » Closed (outdated)