Problem/Motivation

Replace README.txt with README.md

Proposed resolution

update the README following this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Issue fork plupload-3317550

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:

Comments

nitapawar created an issue. See original summary.

nitapawar’s picture

Status: Active » Needs review
nitapawar’s picture

Issue summary: View changes
nitapawar’s picture

Issue summary: View changes
nitapawar’s picture

Nila Hyalij’s picture

Status: Needs review » Reviewed & tested by the community

Patch looks good for me.
Moving to RTBC.

avpaderno’s picture

Title: Need to replace README.txt with README.md format » Replace README.txt with README.md
Status: Reviewed & tested by the community » Needs work

Renaming a file isn't sufficient. Either the file is changed to use Markdown markup, or the file extension is left as it is, since the Drupal coding standards say:

All documentation files should have the file name extension ".txt" to make viewing them on Windows systems easier. Also, the file names for such files should be all-caps (e.g. README.txt instead of readme.txt) while the extension itself is all-lowercase (i.e. txt instead of TXT).

Furthermore, the Drupal coding standards for the Markdown markup are still discussed.

dharmeshbarot’s picture

Assigned: Unassigned » dharmeshbarot
StatusFileSize
new3.62 KB

please check this.

avpaderno’s picture

+with Drupal forms. To install the Plupload library:
+
+1. Download it (version 2.1.9 or later) from
+
+https://github.com/moxiecode/plupload/releases.
+
+1. Unzip it into libraries folder, so that there's a
+
+libraries/plupload/js/plupload.full.min.js file, in addition to the other
+
+files included in the library.

Those empty lines aren't necessary.

+$form['my\_element'] = array(
+
+'#type' => 'plupload',
+
+'#title' => t('Upload files'),
+
+'#description' => t('This multi-upload widget uses Plupload library.'),
+
+'#autoupload' => TRUE,
+
+'#autosubmit' => TRUE,
+
+'#submit\_element' => '#id-of-your-submit-element',
+
+'#upload\_validators' => array(
+
+'file\_validate\_extensions' => array('jpg jpeg gif png txt doc xls pdf ppt
+
+pps odt ods odp'),
+
+'my\_custom\_file\_validator' => array('some validation criteria'),
+
+);
+
+'#plupload\_settings' => array(
+
+'runtimes' => 'html5',
+
+'chunk\_size' => '1mb',
+
+),
+
+'#event\_callbacks' => array(
+
+'FilesAdded' => 'Drupal.mymodule.filesAddedCallback',
+
+'UploadComplete' => 'Drupal.mymodule.uploadCompleteCallback',
+
+),

Code should be formatted as code.

avpaderno’s picture

Version: 2.0.0-beta1 » 2.0.x-dev

The patch needs also to remove the README.,txt file, since that is replaced by the README.md file.

dharmeshbarot’s picture

Status: Needs work » Needs review
StatusFileSize
new3.63 KB

First use git rm README.txt
and then use this patch.

avpaderno’s picture

Status: Needs review » Needs work

Actually, it's the patch that needs to remove the README.txt file.

dharmeshbarot’s picture

Status: Needs work » Needs review
StatusFileSize
new6.32 KB

Now check

karanpagare’s picture

Status: Needs review » Needs work
StatusFileSize
new7.53 KB

Facing this error while applying patch #14

avpaderno’s picture

Patch in comment #14 is altering a file that doesn't exist in the project repository, and it still doesn't remove the README.txt file.

anchal_gupta’s picture

StatusFileSize
new101 bytes

Rename the file

avpaderno’s picture

Simply renaming a file isn't sufficient. A README.md content needs to be Markdown markup.

dharmeshbarot’s picture

Status: Needs work » Needs review
StatusFileSize
new2.58 KB

I think this might work.

karanpagare’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new8.28 KB

Patch #19 applied successfully and replaces README.txt with README.md

Nila Hyalij’s picture

I have tested patch #19.
It's working fine.

budalokko’s picture

Status: Reviewed & tested by the community » Needs work

Thanks for the work been done.

  • Code blocks seem broken, all code in one line. Please wrap them with ``` so they look better.
  • The "For developers" contained some characters which made sense in a txt file but can be removed in md format too.

Please use some kind of markdown viewer to check the final result.

budalokko’s picture

StatusFileSize
new271.87 KB

Hope the attached image clarifies my previous comment.

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

ressa’s picture

Assigned: dharmeshbarot » Unassigned
Status: Needs work » Needs review

I agree @budalokko, people ought to preview the actual rendered result, before asking for a review. It is actually quite easy, since the Gitlab integration provides this, simply by clicking the branch name 3317550-need-to-replace.

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Added the some integration of the Markdown format.

Sonal Gyanani’s picture

Status: Needs review » Reviewed & tested by the community

Thanks, README.md file looks good.
Moving it to RTBC

  • budalokko committed 2f52fb40 on 2.0.x authored by nitapawar
    git commit -m 'Issue #3317550 by dharmeshbarot, ressa, nitapawar,...
budalokko’s picture

Status: Reviewed & tested by the community » Fixed

Committed !! The final result looks lovely. Thanks all who participated.

ressa’s picture

Thanks @budalokko! Perhaps change default branch to 2.x? Right now, you get the 1.x branch with README.txt: https://git.drupalcode.org/project/plupload/

budalokko’s picture

Nice catch. Changed. Thank you !!

ressa’s picture

Perfect, thanks for maintaining the module. Have a nice day.

Status: Fixed » Closed (fixed)

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