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
#5 3319892-3.patch2.56 KBNila Hyalij
#2 3319892-2.patch1.87 KBNila Hyalij

Comments

Nila Hyalij created an issue. See original summary.

Nila Hyalij’s picture

Nila Hyalij commented
StatusFileSize
new 3319892-2.patch1.87 KB
Nila Hyalij’s picture

Nila Hyalij commented
Status: Active » Needs review

I have added patch with changes.
Please review it.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work

#2 patch
please check your patch file and update

Nila Hyalij’s picture

Nila Hyalij commented
StatusFileSize
new 3319892-3.patch2.56 KB

Hi @Manoj Raj.R ,
here is the updated patch file.
please review it.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Reviewed & tested by the community

This #5 patch looks good to me.
So moving to RTBC.

  • MegaChriz committed 32d0ccf on 8.x-3.x 
    Issue #3319892 by Nila Hyalij, Manoj Raj.R, MegaChriz: Replaced README....
megachriz’s picture

megachriz
Primary language Dutch
commented
Status: Reviewed & tested by the community » Fixed

Thanks for the patch. I kept the number of number signs (#), because the patch changed the structure of the document.

This is the intended structure:

  • Contents of this file
  • Introduction
    • Features
    • Resources
  • Requirements
  • Installation
  • Configuration
  • Maintainers
    • Current maintainers
    • Historical maintainers

And the patch changed that into:

  • Contents of this file
  • Introduction
  • Features
  • Resources
  • Requirements
  • Installation
  • Configuration
  • Maintainers
  • Current maintainers
  • Historical maintainers

Essential removing a level from the document structure.

So I reverted that change from the patch. Additionally, I added a header on the top of the file:

Feeds
=====

And committed that result.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.