Browse Source

Resort menu

Renée Kooi 6 years ago
parent
commit
a6604ea4ff

+ 1 - 1
website/src/docs/aws-s3-multipart.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 43
+order: 53
 title: "AWS S3 Multipart"
 title: "AWS S3 Multipart"
 module: "@uppy/aws-s3-multipart"
 module: "@uppy/aws-s3-multipart"
 permalink: docs/aws-s3-multipart/
 permalink: docs/aws-s3-multipart/

+ 1 - 1
website/src/docs/aws-s3.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 42
+order: 52
 title: "AWS S3"
 title: "AWS S3"
 module: "@uppy/aws-s3"
 module: "@uppy/aws-s3"
 permalink: docs/aws-s3/
 permalink: docs/aws-s3/

+ 2 - 2
website/src/docs/dashboard.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 20
+order: 30
 title: "Dashboard"
 title: "Dashboard"
 module: "@uppy/dashboard"
 module: "@uppy/dashboard"
 permalink: docs/dashboard/
 permalink: docs/dashboard/
@@ -152,7 +152,7 @@ Hide the retry button. Use this if you are providing a custom retry button somew
 
 
 ### `hidePauseResumeButton: false`
 ### `hidePauseResumeButton: false`
 
 
-Passed to the Status Bar plugin used in the Dashboard. 
+Passed to the Status Bar plugin used in the Dashboard.
 
 
 Hide pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)` or `uppy.removeFile(fileID)` API.
 Hide pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)` or `uppy.removeFile(fileID)` API.
 
 

+ 1 - 1
website/src/docs/dragdrop.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 21
+order: 31
 title: "Drag & Drop"
 title: "Drag & Drop"
 module: "@uppy/drag-drop"
 module: "@uppy/drag-drop"
 permalink: docs/drag-drop/
 permalink: docs/drag-drop/

+ 1 - 1
website/src/docs/dropbox.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 31
+order: 41
 title: "Dropbox"
 title: "Dropbox"
 module: "@uppy/dropbox"
 module: "@uppy/dropbox"
 permalink: docs/dropbox/
 permalink: docs/dropbox/

+ 1 - 1
website/src/docs/fileinput.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 22
+order: 32
 title: "File Input"
 title: "File Input"
 module: "@uppy/file-input"
 module: "@uppy/file-input"
 permalink: docs/file-input/
 permalink: docs/file-input/

+ 1 - 1
website/src/docs/form.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 70
+order: 80
 title: "Form"
 title: "Form"
 module: "@uppy/form"
 module: "@uppy/form"
 permalink: docs/form/
 permalink: docs/form/

+ 1 - 1
website/src/docs/golden-retriever.md

@@ -3,7 +3,7 @@ title: "Golden Retriever"
 module: "@uppy/golden-retriever"
 module: "@uppy/golden-retriever"
 type: docs
 type: docs
 permalink: docs/golden-retriever/
 permalink: docs/golden-retriever/
-order: 71
+order: 81
 ---
 ---
 
 
 The `@uppy/golden-retriever` plugin saves selected files in your browser cache, so that if the browser crashes, Uppy can restore everything and continue uploading as if nothing happened. You can read more about it [on our blog](https://uppy.io/blog/2017/07/golden-retriever/).
 The `@uppy/golden-retriever` plugin saves selected files in your browser cache, so that if the browser crashes, Uppy can restore everything and continue uploading as if nothing happened. You can read more about it [on our blog](https://uppy.io/blog/2017/07/golden-retriever/).

+ 1 - 1
website/src/docs/google-drive.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 32
+order: 42
 title: "Google Drive"
 title: "Google Drive"
 module: "@uppy/google-drive"
 module: "@uppy/google-drive"
 permalink: docs/google-drive/
 permalink: docs/google-drive/

+ 1 - 1
website/src/docs/informer.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 52
+order: 62
 title: "Informer"
 title: "Informer"
 module: "@uppy/informer"
 module: "@uppy/informer"
 permalink: docs/informer/
 permalink: docs/informer/

+ 1 - 1
website/src/docs/instagram.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 33
+order: 43
 title: "Instagram"
 title: "Instagram"
 module: "@uppy/instagram"
 module: "@uppy/instagram"
 permalink: docs/instagram/
 permalink: docs/instagram/

+ 1 - 1
website/src/docs/plugins.md

@@ -2,7 +2,7 @@
 title: "List & Common Options"
 title: "List & Common Options"
 type: docs
 type: docs
 permalink: docs/plugins/
 permalink: docs/plugins/
-order: 10
+order: 20
 ---
 ---
 
 
 Plugins are what makes Uppy useful: they help select, manipulate and upload files.
 Plugins are what makes Uppy useful: they help select, manipulate and upload files.

+ 1 - 1
website/src/docs/progressbar.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 51
+order: 61
 title: "Progress Bar"
 title: "Progress Bar"
 module: "@uppy/progress-bar"
 module: "@uppy/progress-bar"
 permalink: docs/progress-bar/
 permalink: docs/progress-bar/

+ 2 - 2
website/src/docs/providers.md

@@ -2,14 +2,14 @@
 title: "Provider Plugins"
 title: "Provider Plugins"
 type: docs
 type: docs
 permalink: docs/providers/
 permalink: docs/providers/
-order: 30
+order: 40
 ---
 ---
 
 
 The Provider plugins help you connect to your accounts with remote file providers such as [Dropbox](https://dropbox.com), [Google Drive](https://drive.google.com), [Instagram](https://instagram.com) and remote URLs (importing a file by pasting a direct link to it). Because this requires server-to-server communication, they work tightly with [Companion](https://github.com/transloadit/companion) to manage the server-to-server authorization for your account. Almost all of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress and bills of data consumption on the client.
 The Provider plugins help you connect to your accounts with remote file providers such as [Dropbox](https://dropbox.com), [Google Drive](https://drive.google.com), [Instagram](https://instagram.com) and remote URLs (importing a file by pasting a direct link to it). Because this requires server-to-server communication, they work tightly with [Companion](https://github.com/transloadit/companion) to manage the server-to-server authorization for your account. Almost all of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress and bills of data consumption on the client.
 
 
 As of now, the supported providers are [**Dropbox**](/docs/dropbox), [**GoogleDrive**](/docs/google-drive), [**Instagram**](/docs/instagram), and [**URL**](/docs/url).
 As of now, the supported providers are [**Dropbox**](/docs/dropbox), [**GoogleDrive**](/docs/google-drive), [**Instagram**](/docs/instagram), and [**URL**](/docs/url).
 
 
-Usage of the Provider plugins is not that different from any other *acquirer* plugin, except that it takes an extra option `serverUrl`, which specifies the URL to the Companion that you are running. This allows Uppy to know what server to connect to when datacenter operations are required by the provider plugin. 
+Usage of the Provider plugins is not that different from any other *acquirer* plugin, except that it takes an extra option `serverUrl`, which specifies the URL to the Companion that you are running. This allows Uppy to know what server to connect to when datacenter operations are required by the provider plugin.
 
 
 Here's a quick example:
 Here's a quick example:
 
 

+ 1 - 1
website/src/docs/react-dashboard-modal.md

@@ -2,7 +2,7 @@
 title: "<DashboardModal />"
 title: "<DashboardModal />"
 type: docs
 type: docs
 permalink: docs/react/dashboard-modal/
 permalink: docs/react/dashboard-modal/
-order: 85
+order: 95
 ---
 ---
 
 
 The `<DashboardModal />` component wraps the [`@uppy/dashboard`][] plugin, allowing control over the modal `open` state using a prop.
 The `<DashboardModal />` component wraps the [`@uppy/dashboard`][] plugin, allowing control over the modal `open` state using a prop.

+ 1 - 1
website/src/docs/react-dashboard.md

@@ -2,7 +2,7 @@
 title: "&lt;Dashboard />"
 title: "&lt;Dashboard />"
 type: docs
 type: docs
 permalink: docs/react/dashboard/
 permalink: docs/react/dashboard/
-order: 84
+order: 94
 ---
 ---
 
 
 The `<Dashboard />` component wraps the [`@uppy/dashboard`][] plugin. It only renders the Dashboard inline. To use the Dashboard modal (`inline: false`), use the [`<DashboardModal />`](/docs/react/dashboard-modal) component.
 The `<Dashboard />` component wraps the [`@uppy/dashboard`][] plugin. It only renders the Dashboard inline. To use the Dashboard modal (`inline: false`), use the [`<DashboardModal />`](/docs/react/dashboard-modal) component.

+ 1 - 1
website/src/docs/react-dragdrop.md

@@ -3,7 +3,7 @@ title: "&lt;DragDrop />"
 type: docs
 type: docs
 permalink: docs/react/drag-drop/
 permalink: docs/react/drag-drop/
 alias: docs/react/dragdrop/
 alias: docs/react/dragdrop/
-order: 82
+order: 92
 ---
 ---
 
 
 The `<DragDrop />` component wraps the [`@uppy/drag-drop`][] plugin.
 The `<DragDrop />` component wraps the [`@uppy/drag-drop`][] plugin.

+ 1 - 1
website/src/docs/react-progressbar.md

@@ -3,7 +3,7 @@ title: "&lt;ProgressBar />"
 type: docs
 type: docs
 permalink: docs/react/progress-bar/
 permalink: docs/react/progress-bar/
 alias: docs/react/progressbar/
 alias: docs/react/progressbar/
-order: 83
+order: 93
 ---
 ---
 
 
 The `<ProgressBar />` component wraps the [`@uppy/progress-bar`][] plugin.
 The `<ProgressBar />` component wraps the [`@uppy/progress-bar`][] plugin.

+ 1 - 1
website/src/docs/react-statusbar.md

@@ -3,7 +3,7 @@ title: "&lt;StatusBar />"
 type: docs
 type: docs
 permalink: docs/react/status-bar/
 permalink: docs/react/status-bar/
 alias: docs/react/statusbar/
 alias: docs/react/statusbar/
-order: 81
+order: 91
 ---
 ---
 
 
 The `<StatusBar />` component wraps the [`@uppy/status-bar`][] plugin.
 The `<StatusBar />` component wraps the [`@uppy/status-bar`][] plugin.

+ 1 - 1
website/src/docs/react.md

@@ -2,7 +2,7 @@
 title: "Introduction"
 title: "Introduction"
 type: docs
 type: docs
 permalink: docs/react/
 permalink: docs/react/
-order: 80
+order: 90
 ---
 ---
 
 
 Uppy provides [React][] components for the included UI plugins.
 Uppy provides [React][] components for the included UI plugins.

+ 1 - 1
website/src/docs/redux.md

@@ -2,7 +2,7 @@
 title: "Redux"
 title: "Redux"
 type: docs
 type: docs
 permalink: docs/redux/
 permalink: docs/redux/
-order: 87
+order: 97
 ---
 ---
 
 
 Uppy supports the popular [Redux](https://redux.js.org/) state management library in two ways:
 Uppy supports the popular [Redux](https://redux.js.org/) state management library in two ways:

+ 1 - 1
website/src/docs/statusbar.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 50
+order: 60
 title: "Status Bar"
 title: "Status Bar"
 module: "@uppy/status-bar"
 module: "@uppy/status-bar"
 permalink: docs/status-bar/
 permalink: docs/status-bar/

+ 35 - 2
website/src/docs/transloadit-preset-form.md

@@ -1,8 +1,41 @@
 ---
 ---
 type: docs
 type: docs
-title: "Form API Documentation"
+title: "Transloadit Preset: Form API"
+menu: "Form"
 permalink: docs/transloadit-preset/form/
 permalink: docs/transloadit-preset/form/
-hidden: true
+order: 12
 ---
 ---
 
 
+Add resumable uploads and Transloadit's processing to your existing HTML upload forms. Selected files will be uploaded to Transloadit, and the Assembly information will be submitted to your form endpoint.
 
 
+```html
+<form id="myForm" method="POST" action="/upload">
+  <input type="file" multiple>
+  ...
+</form>
+
+<script>
+transloadit.form('form#myForm', {
+  params: {
+    auth: { key: '' },
+    template_id: ''
+  }
+})
+</script>
+```
+
+When the user submits the form, we intercept it and send the files to Transloadit instead. This creates one or more Assemblies depending on configuration. Then, we put the status JSON object(s) in a hidden input field named `transloadit`.
+
+```html
+<input type="hidden" name="transloadit" value='[{"ok": "ASSEMBLY_EXECUTING",...}]'>
+```
+
+Finally, we _really_ submit the form—without files, but with those Assembly status objects. You can then handle that in your backend.
+
+## Progress Reporting
+
+**TODO have an option to mount a status bar somewhere**
+
+## Dashboard
+
+**TODO have an option to replace the inputs with a Dashboard modal button?**

+ 3 - 2
website/src/docs/transloadit-preset-picker.md

@@ -1,8 +1,9 @@
 ---
 ---
 type: docs
 type: docs
-title: "File Picker API Documentation"
+title: "Transloadit Preset: File Picker API"
+menu: "File Picker"
 permalink: docs/transloadit-preset/picker/
 permalink: docs/transloadit-preset/picker/
-hidden: true
+order: 11
 ---
 ---
 
 
 Show a modal UI that allows users to pick files from their device and from the web. It uploads files to Transloadit for processing.
 Show a modal UI that allows users to pick files from their device and from the web. It uploads files to Transloadit for processing.

+ 3 - 2
website/src/docs/transloadit-preset-upload.md

@@ -1,8 +1,9 @@
 ---
 ---
 type: docs
 type: docs
-title: "Upload API Documentation"
+title: "Transloadit Preset: Upload API"
+menu: "Upload"
 permalink: docs/transloadit-preset/upload/
 permalink: docs/transloadit-preset/upload/
-hidden: true
+order: 13
 ---
 ---
 
 
 Upload files straight to Transloadit from your own custom UI. Give us an array of files, and we'll give you an array of results!
 Upload files straight to Transloadit from your own custom UI. Give us an array of files, and we'll give you an array of results!

+ 2 - 1
website/src/docs/transloadit-preset.md

@@ -1,7 +1,8 @@
 ---
 ---
 type: docs
 type: docs
-order: 4
+order: 10
 title: "Transloadit Preset"
 title: "Transloadit Preset"
+menu: "Introduction"
 module: "@uppy/transloadit-preset"
 module: "@uppy/transloadit-preset"
 permalink: docs/transloadit-preset/
 permalink: docs/transloadit-preset/
 ---
 ---

+ 1 - 1
website/src/docs/transloadit.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 60
+order: 70
 title: "Transloadit"
 title: "Transloadit"
 module: "@uppy/transloadit"
 module: "@uppy/transloadit"
 permalink: docs/transloadit/
 permalink: docs/transloadit/

+ 1 - 1
website/src/docs/tus.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 40
+order: 50
 title: "Tus"
 title: "Tus"
 module: "@uppy/tus"
 module: "@uppy/tus"
 permalink: docs/tus/
 permalink: docs/tus/

+ 1 - 1
website/src/docs/url.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 34
+order: 44
 title: "Import From URL"
 title: "Import From URL"
 module: "@uppy/url"
 module: "@uppy/url"
 permalink: docs/url/
 permalink: docs/url/

+ 1 - 1
website/src/docs/webcam.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 26
+order: 36
 title: "Webcam"
 title: "Webcam"
 module: "@uppy/webcam"
 module: "@uppy/webcam"
 permalink: docs/webcam/
 permalink: docs/webcam/

+ 1 - 1
website/src/docs/writing-plugins.md

@@ -2,7 +2,7 @@
 type: docs
 type: docs
 title: "Writing Plugins"
 title: "Writing Plugins"
 permalink: docs/writing-plugins/
 permalink: docs/writing-plugins/
-order: 11
+order: 21
 ---
 ---
 
 
 There are already a few useful Uppy plugins out there, but there might come a time when you will want to build your own. Plugins can hook into the upload process or render a custom UI, typically to:
 There are already a few useful Uppy plugins out there, but there might come a time when you will want to build your own. Plugins can hook into the upload process or render a custom UI, typically to:

+ 1 - 1
website/src/docs/xhrupload.md

@@ -1,6 +1,6 @@
 ---
 ---
 type: docs
 type: docs
-order: 41
+order: 51
 title: "XHR Upload"
 title: "XHR Upload"
 module: "@uppy/xhr-upload"
 module: "@uppy/xhr-upload"
 permalink: docs/xhr-upload/
 permalink: docs/xhr-upload/

+ 11 - 9
website/themes/uppy/layout/partials/sidebar.ejs

@@ -1,20 +1,22 @@
 <%
 <%
 var categories = [
 var categories = [
   // order: 1x
   // order: 1x
-  { path: 'docs/plugins/', name: 'Plugins', link: true },
+  { path: 'docs/transloadit-preset/', name: 'Transloadit Preset', link: true },
   // order: 2x
   // order: 2x
-  { path: 'docs/dashboard/', name: 'Local Sources', link: false },
+  { path: 'docs/plugins/', name: 'Plugins', link: true },
   // order: 3x
   // order: 3x
-  { path: 'docs/providers/', name: 'Remote Providers', link: true },
+  { path: 'docs/dashboard/', name: 'Local Sources', link: false },
   // order: 4x
   // order: 4x
-  { path: 'docs/tus/', name: 'Uploaders', link: false },
+  { path: 'docs/providers/', name: 'Remote Providers', link: true },
   // order: 5x
   // order: 5x
-  { path: 'docs/status-bar/', name: 'UI Elements', link: false },
+  { path: 'docs/tus/', name: 'Uploaders', link: false },
   // order: 6x
   // order: 6x
-  { path: 'docs/transloadit/', name: 'File Processing', link: false },
+  { path: 'docs/status-bar/', name: 'UI Elements', link: false },
   // order: 7x
   // order: 7x
-  { path: 'docs/form/', name: 'Miscellaneous', link: false },
+  { path: 'docs/transloadit/', name: 'File Processing', link: false },
   // order: 8x
   // order: 8x
+  { path: 'docs/form/', name: 'Miscellaneous', link: false },
+  // order: 9x
   { path: 'docs/react/', name: 'React Components', link: true },
   { path: 'docs/react/', name: 'React Components', link: true },
 ]
 ]
 %>
 %>
@@ -43,11 +45,11 @@ var categories = [
             <% } %>
             <% } %>
           </li>
           </li>
           <li>
           <li>
-            <a href="/<%- path %>" class="sidebar-link<%- page.title === p.title ? ' current' : '' %><%- p.is_new ? ' new' : '' %>"><%- p.title %></a>
+            <a href="/<%- path %>" class="sidebar-link<%- page.title === p.title ? ' current' : '' %><%- p.is_new ? ' new' : '' %>"><%- p.menu || p.title %></a>
           </li>
           </li>
         <% } else { %>
         <% } else { %>
           <li>
           <li>
-            <a href="/<%- path %>" class="sidebar-link<%- page.title === p.title ? ' current' : '' %><%- p.is_new ? ' new' : '' %>"><%- p.title %></a>
+            <a href="/<%- path %>" class="sidebar-link<%- page.title === p.title ? ' current' : '' %><%- p.is_new ? ' new' : '' %>"><%- p.menu || p.title %></a>
           </li>
           </li>
         <% } %>
         <% } %>
       <% }) %>
       <% }) %>