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

Issue fork field_gallery-3350544

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

dineshkumarbollu created an issue. See original summary.

dineshkumarbollu opened merge request !2

dineshkumarbollu’s picture

dineshkumarbollu commented
Assigned: dineshkumarbollu » Unassigned
Status: Active » Needs review

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

hardikpandya’s picture

hardikpandya commented

I have added the table of contents which was missing in the README file.

nupur badola’s picture

nupur badola commented

Patch is working but there are errors in the patch.

2.diff.txt:7: trailing whitespace.
# TABLE OF CONTENTS
2.diff.txt:8: trailing whitespace.

2.diff.txt:9: trailing whitespace.
 * INTRODUCTION[#introduction]
2.diff.txt:10: trailing whitespace.
 * INSTALLATION[#installation]
2.diff.txt:11: trailing whitespace.
 * REQUIREMENTS[#requirements]
warning: README.txt has type 100644, expected 100755
warning: squelched 63 whitespace errors
warning: 68 lines add whitespace errors.
nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewed MR!2, File is not updated as per readme.md file template. Please refer the format mentioned here: https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

ravi kant’s picture

ravi kant commented
Status: Needs work » Needs review

Updated readme file.

nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewed MR!2, the file has still some issues:

2.diff.txt:7: trailing whitespace.
# Field Gallery
2.diff.txt:8: trailing whitespace.

2.diff.txt:9: trailing whitespace.
Field Gallery provide a field formatter for image fields to render
2.diff.txt:10: trailing whitespace.
as an image gallery.
2.diff.txt:11: trailing whitespace.

warning: README.txt has type 100644, expected 100755
warning: squelched 63 whitespace errors
warning: 68 lines add whitespace errors.
ravi kant’s picture

ravi kant commented
Status: Needs work » Needs review

Removed whtespace.

nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewed MR!2, the file has still some errors:

2.diff.txt:7: trailing whitespace.
# Field Gallery
2.diff.txt:8: trailing whitespace.

2.diff.txt:9: trailing whitespace.
Field Gallery provide a field formatter for image fields to render
2.diff.txt:10: trailing whitespace.
as an image gallery.
2.diff.txt:11: trailing whitespace.

warning: README.txt has type 100644, expected 100755
warning: squelched 64 whitespace errors
warning: 69 lines add whitespace errors.

ravi kant opened merge request !4

ravi kant closed merge request !4

gajanan.wasnik made their first commit to this issue’s fork.

gajanan.wasnik’s picture

gajanan.wasnik commented
Status: Needs work » Needs review
a.aaronjake’s picture

a.aaronjake commented
Status: Needs review » Reviewed & tested by the community

Hi @gajanan.wasnik,

Applied MR !2 successfully, README.txt is replaced with README.md
The README.md also follows the README.md template

field_gallery git:(2.0.x) curl https://git.drupalcode.org/project/field_gallery/-/merge_requests/2.diff | patch
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  3548    0  3548    0     0   4635      0 --:--:-- --:--:-- --:--:--  4705
patching file README.md
patching file README.txt

Will change the status to RTBC.
Thank you.