Replace README.txt with README.md

Created on 18 November 2022, almost 2 years ago
Updated 1 June 2023, over 1 year ago

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...

📌 Task
Status

Fixed

Version

1.2

Component

Documentation

Created by

🇮🇳India Raghavendra A M

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • First commit to issue fork.
  • 🇦🇺Australia klonos 90% Melbourne, Australia - 10% Larissa, Greece

    I have reviewed this and fixed even more things:

    • Added single line after all headings
    • Removed extra lines (more than 2) in some places
    • Added 2 lines after headings
    • Indented the nested list items in the ToC at the top by 4 spaces
    • Removed leading spaces from paragraphs
    • Wrapped paragraphs at 80 characters (besides a link, which was previously wrapped in a way that was breaking it in my markdown viewer)
    • Added dots after the numbers in the heading for consistency with other headings. We can remove the dots, but we need to be consistent - some headings had them before, while others didn't have them.
    • Added a couple of commas mid-sentense where it made sense.
    • Converted the instructions on permissions to a bullet point list.

    Could use another round of review from someone else now, in case I missed something.

  • 🇦🇺Australia klonos 90% Melbourne, Australia - 10% Larissa, Greece

    ...another last edit to create a "Maintainers" section at the end of the file, and add both maintainers there.

  • Status changed to Needs work over 1 year ago
  • 🇦🇺Australia jannakha Brisbane!

    MR is good, but it looks like README.org is the original readme file (txt is generated from org file - https://en.wikipedia.org/wiki/Org-mode)
    Maybe readme.org should be deleted and only readme.md used to keep codebase clean?

  • 🇮🇳India Manoj Raj.R Chennai

    @apatel0325

    Your MR doesnot Replace README.txt with README.md.

    I will work on it.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Manoj Raj.R Chennai

    Updated as per the latest Readme Template Format.
    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

    MR !6 should be able to mergeble.

    Please review.

  • Status changed to Needs work over 1 year ago
  • 🇮🇳India Anmol_Specbee

    The MR !6 doesn't replace the readme.txt with readme.md.

  • 🇮🇳India Manoj Raj.R Chennai

    @Anmol_Specbee

    Can you explain elaborately.

    Its actually changed accordingly changed from my side.

    Attached the screenshot for it.

  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC over 1 year ago
  • 🇮🇳India Anmol_Specbee

    The patch is working as expected. Moving to RTBC.

  • Assigned to Kristen Pol
  • 🇺🇸United States Kristen Pol Santa Cruz, CA, USA

    Hi all... thanks for this work! I like that the README formatting was actually improved during this rather than simply changing it to .md which wouldn't have been as useful.

    Please note: I have only credited people who made substantial progress on this issue. Some of the comments and forks seemed to cause some confusion and didn't help move this issue forward so I didn't credit that work.

    For reviews and updates, @klonos has a wonderful example above in #7 of being very clear about what they were doing. I would encourage all contributors to use that as an example for their contributions going forward. i.e. if you are making changes, explain what changes and, if reviewing, be clear about what needs changing.

    Assigning to myself to get this into the next release.

    • Kristen Pol committed 6d99bd4f on 8.x-1.x
      Issue #3322447 by Manoj Raj.R, Raghavendra A M, klonos, Kristen Pol:...
  • Issue was unassigned.
  • Status changed to Fixed over 1 year ago
  • 🇺🇸United States Kristen Pol Santa Cruz, CA, USA

    This has been merged and will be in the next release :)

  • 🇺🇸United States Kristen Pol Santa Cruz, CA, USA

    A new 8.x-1.3 release has been created that includes this fix:

    https://www.drupal.org/project/securitytxt/releases/8.x-1.3

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

Production build 0.71.5 2024