Problem/Motivation
Replace README.txt with README.md
Steps to reproduce
update the README
Proposed resolution
following this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
| Comment | File | Size | Author |
|---|---|---|---|
| #20 | date_readme.PNG | 31.83 KB | kavitha89 |
Issue fork date-3318896
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
Comment #2
gowthami reddy commentedAs per md format the readme file
Comment #3
damienmckennaThank you, but the 8.x-1.x branch is not supported because Drupal core has some (limited) date field support.
Comment #4
Manoj Raj.R commentedCan we use it in 7x version to change the Readme txt to Readme md format.
Comment #5
damienmckennaSure.
Comment #6
Manoj Raj.R commentedComment #8
Manoj Raj.R commentedComment #10
Manoj Raj.R commentedRecent commit in the branch 3318896-replace-txt.
Please review it.
Comment #11
damienmckennaThis needs further work to use the Markdown format properly, e.g. instead of having links in a separate "References" section they should be inline.
Comment #12
Manoj Raj.R commentedUpdated the references section with markdown format Links.
Please review it.
Comment #13
WagnerMelo commentedHi, i'll review it. XD
Comment #14
WagnerMelo commentedI reviewed this issue, and the changes maded by @Manoj Raj.R look like ok to me, and attends the patterns asked by @DamienMcKenna at #11.
And i didn't have any problem to apply this patch, so i'll move this issue to RTBC.
Comment #16
damienmckennaThis needs some work to use the Markdown format better, e.g. instead of having a separate "references" section each link should be inline. Also, the bulleted list for the submodules list needs to be reformatted.
Comment #19
shivam_tiwari commentedComment #20
kavitha89 commentedThe patch works fine and moving it to RTBC.
Comment #22
damienmckenna1. Please don't create a new merge request when the maintainer asks for changes to an existing merge request. Instead, please update the existing merge request with the requested changes.
2. Please don't post screenshots of merge requests applying and saying "works fine", that is a waste of time. Instead, please review the merge request's changes and see if it includes the changes requested by the maintainer.
Setting this back to "needs work" as none of my feedback was considered.
Comment #24
thakurnishant_06 commentedHello @DamienMcKenna,
Hope you are doing well. Updated the Readme.md file as per the README.md template.
Kindly review the changes.
Thank you.
Comment #25
nupur badola commentedReviewed MR!18, the patch is not cleanly applied.
Comment #30
nitin_lamaComment #31
nitin_lamaComment #32
nitin_lamaComment #33
nupur badola commentedReviewed MR!18, the patch is not cleanly applied
Table of content does not written in correct format as per template.
it should be written like this: ## Table of contents
- Requirements
- Recommended modules
- Installation
- Configuration
- Troubleshooting
- FAQ
- Maintainers
Comment #35
bharath-kondeti commentedComment #36
kenyoowen commentedHi bharath-kondeti
I reviewed your changes in MR!18 and missing the "modules" text in ## Related section. The format for the Related section is wrong it should be
[Calendar](http://drupal.org/project/calendar)so it's easy to visit the Calendar module and other modules that are in the Related section. As per comment #33 Table of contents is not following README.md.Thank you.
Comment #38
gajanan.wasnik commentedComment #39
steinmb commentedComment #40
clarkssquared commentedHi
I applied the updated MR !18, and it replaced the README.txt file with README.md with the content below
RTBC +1 from me