storage: explain gcs-resumable-upload (#1692)

stephenplusplus · callmehiphop · commit 14565efa7e5f · 2016-10-16T13:37:22.000-04:00
diff --git a/packages/storage/src/file.js b/packages/storage/src/file.js
@@ -749,7 +749,12 @@ File.prototype.createResumableUpload = function(options, callback) {
  * A File object can also be used to create files for the first time.
  *
  * Resumable uploads are automatically enabled and must be shut off explicitly
- * by setting `options.resumable` to `false`.
+ * by setting `options.resumable` to `false`. We use
+ * [`gcs-resumable-upload`](https://github.com/stephenplusplus/gcs-resumable-upload),
+ * which persists a config file with metadata about the upload request (see
+ * ["How it works"](https://github.com/stephenplusplus/gcs-resumable-upload#how-it-works)).
+ * If you start running into unexplainable errors, try clearing this cache file
+ * located at `~/.config/configstore/gcs-resumable-upload.json`.
  *
  * <p class="notice">
  *   There is some overhead when using a resumable upload that can cause

Original file line number	Diff line number	Diff line change
`@@ -749,7 +749,12 @@ File.prototype.createResumableUpload = function(options, callback) {`
`749`	`749`	`* A File object can also be used to create files for the first time.`
`750`	`750`	`*`
`751`	`751`	`* Resumable uploads are automatically enabled and must be shut off explicitly`
`752`		- * by setting `options.resumable` to `false`.
	`752`	+ * by setting `options.resumable` to `false`. We use
	`753`	+ * [`gcs-resumable-upload`](https://github.com/stephenplusplus/gcs-resumable-upload),
	`754`	`+ * which persists a config file with metadata about the upload request (see`
	`755`	`+ * ["How it works"](https://github.com/stephenplusplus/gcs-resumable-upload#how-it-works)).`
	`756`	`+ * If you start running into unexplainable errors, try clearing this cache file`
	`757`	+ * located at `~/.config/configstore/gcs-resumable-upload.json`.
`753`	`758`	`*`
`754`	`759`	`* <p class="notice">`
`755`	`760`	`* There is some overhead when using a resumable upload that can cause`