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
#14 readme-3321599-14.patch156 bytessakthi_dev
#11 interdiff_9-11.txt901 bytesgovind_giri_goswami
#11 3321599-11.patch207 bytesgovind_giri_goswami
#9 3321599-9.patch906 bytesnitin_lama
#7 3321599 - after.png118.01 KBkenyoowen
#7 3321599 - before.png70.88 KBkenyoowen
#5 dh_reference.png168.66 KBnupur badola
#4 interdiff_2-4.txt152 bytesmrinalini9
#4 3321599-4.patch540 bytesmrinalini9
#2 3321599-2.patch542 bytespanwarjatin

Issue fork dh_viewsreference-3321599

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

panwarjatin created an issue. See original summary.

panwarjatin’s picture

panwarjatin commented
Status: Active » Needs review
StatusFileSize
new 3321599-2.patch542 bytes

Changed README.txt to README.md please review it.

Thank you.

nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Error in the patch.

3321599-2.patch.txt:17: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
mrinalini9’s picture

mrinalini9 commented
Status: Needs work » Needs review
StatusFileSize
new 3321599-4.patch540 bytes
new interdiff_2-4.txt152 bytes

Updated patch #2 by addressing #3, please review it.

Thanks!

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new dh_reference.png168.66 KB

Patch is working and marking 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 review

It would be better if somebody else reviews the patch.

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work
StatusFileSize
new 3321599 - before.png70.88 KB
new 3321599 - after.png118.01 KB

Hi mrinalini9

I applied and reviewed your patch it does replace README.txt with README.md, but it doesn't follow the 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
nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned
StatusFileSize
new 3321599-9.patch906 bytes
govind_giri_goswami’s picture

govind_giri_goswami commented
Assigned: Unassigned » govind_giri_goswami
govind_giri_goswami’s picture

govind_giri_goswami commented
Status: Needs work » Needs review
StatusFileSize
new 3321599-11.patch207 bytes
new interdiff_9-11.txt901 bytes

i have created a patch. please review it.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Assigned: govind_giri_goswami » Unassigned
avpaderno’s picture

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

Either the Configuration section is not added to the Table of contents section, or content it is provided for that section. If the module does not use configuration, the section should say that.

sakthi_dev’s picture

sakthi_dev commented
Status: Needs work » Needs review
StatusFileSize
new readme-3321599-14.patch156 bytes

Updated the Configuration section. Please review.

avpaderno’s picture

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

The last patch does not seem correct.

diff --git a/README.txt b/README.txt
deleted file mode 100644
index 4339ca7..0000000
--- a/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Doghouse Views Reference

Mohd Sahzad made their first commit to this issue’s fork.

Mohd Sahzad opened merge request !1

mohd sahzad’s picture

mohd sahzad commented
Status: Needs work » Needs review

Hi @Carlopogus,
i have updated this Replace README.txt with README.md , so please review..

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work

Hi Mohd Sahzad

I reviewed your MR!1 and it doesn't follow the README.md template.

Drupal recommends the following README sections:

Project name and introduction (required)
Table of contents (optional)
Requirements (required)
Recommended modules (optional)
Installation (required, unless a separate INSTALL.md is provided)
Configuration (required)
Troubleshooting & FAQ (optional)
Maintainers (optional)

Thank you

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

thakurnishant_06’s picture

thakurnishant_06 commented
Status: Needs work » Needs review
nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewwd MR!1, the patch is not cleanly applied.

1. Two lines prior to ##/### headings. Lines need above Maintainers section.
thakurnishant_06’s picture

thakurnishant_06 commented
Status: Needs work » Needs review
nupur badola’s picture

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

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