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.

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

Issue fork flippy-3321515

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

Raghavendra A M created an issue. See original summary.

Raghavendra A M opened merge request !8

raghavendra a m’s picture

raghavendra a m commented

Committed according to the proposed solution.

Please review it.

nupur badola’s picture

nupur badola commented

Getting issue
warning: README.txt has type 100644, expected 100755

nupur badola’s picture

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

ravi kant commented

The MR also not following README.md template standards.

ravi kant’s picture

ravi kant commented
Status: Needs work » Needs review

I have updated MR !8.

nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

@ravikant
still getting the same issue:

1. warning: README.txt has type 100644, expected 100755.
2. Troublshooting and FAQ section is given in table of contents, however detailed section is missing, so either remove it from table of content or mention their detail section.
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
Status: Needs work » Needs review

Please review. Thanks.

nitin_lama’s picture

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

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

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

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

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented
Status: Reviewed & tested by the community » Fixed

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.