Moodle Community Sites
  1. Moodle Community Sites
  2. MDLSITE-1545

Plugins database validator ignores other formats of the README file

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Component/s: moodle.org/plugins
    • Labels:
      None
    • Rank:
      19682

      Description

      README files written in Markdown are popular and common in Github repositories. These files use to have ".md" extension. But when a plugin is recorded in the Plugins database, the validator checks for "README" and "README.txt" only.

      It would be better to

      • either allow README.md
      • or even better to allow README[.*] (any optional extension - others may prefer README.html, README.texy or whatever)

        Activity

        Hide
        Petr Škoda added a comment -

        +1 for .md

        Show
        Petr Škoda added a comment - +1 for .md
        Hide
        Martin Dougiamas added a comment -

        Yeah, any README.xxx or README.xx is fine.

        Show
        Martin Dougiamas added a comment - Yeah, any README.xxx or README.xx is fine.
        Hide
        Marina Glancy added a comment -

        Do you think we should suggest contributors to automatically rename README and/or README.md into README.txt ? (The same way we suggest to rename the root folder and remove hidden files)

        Because files with extensions unknown to OS will not open in text editor. It had just happened for me with README.md in Ubuntu.

        Show
        Marina Glancy added a comment - Do you think we should suggest contributors to automatically rename README and/or README.md into README.txt ? (The same way we suggest to rename the root folder and remove hidden files) Because files with extensions unknown to OS will not open in text editor. It had just happened for me with README.md in Ubuntu.
        Hide
        Marina Glancy added a comment -

        We now look for README.* (and README) and suggest to rename it to README.txt for compatibility with any OS.

        README.htm, README.html are not renamed and content is considered to be in HTML format. Although I did not see yet any plugins with html release notes

        This issue was fixed already some time ago, just forgot to close it.

        Show
        Marina Glancy added a comment - We now look for README.* (and README) and suggest to rename it to README.txt for compatibility with any OS. README.htm, README.html are not renamed and content is considered to be in HTML format. Although I did not see yet any plugins with html release notes This issue was fixed already some time ago, just forgot to close it.

          People

          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development