Browse Source

Sort doc pages and add headers.

Renée Kooi 6 years ago
parent
commit
31358bc73e

+ 3 - 3
website/src/docs/api.md

@@ -1,6 +1,6 @@
-\----		
-type: docs		
-order: 30	
+\----
+type: docs
+order: 99
 
 ## title: "Generated API"
 

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

@@ -1,7 +1,7 @@
 ---
 type: docs
-order: 33
-title: "Aws S3 Multipart"
+order: 43
+title: "AWS S3 Multipart"
 permalink: docs/aws-s3-multipart/
 ---
 

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

@@ -1,7 +1,7 @@
 ---
 type: docs
-order: 32
-title: "Aws S3"
+order: 42
+title: "AWS S3"
 permalink: docs/aws-s3/
 ---
 

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

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

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

@@ -1,6 +1,6 @@
 ---
 type: docs
-order: 25
+order: 22
 title: "File Input"
 permalink: docs/file-input/
 alias: docs/fileinput/

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

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

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

@@ -2,7 +2,7 @@
 title: "Golden Retriever"
 type: docs
 permalink: docs/golden-retriever/
-order: 40
+order: 71
 ---
 
 The GoldenRetriever plugin saves selected files in your browser cache (Local Storage for metadata, then Service Worker for all blobs + IndexedDB for small blobs), so that if the browser crashes, Uppy can restore everything and continue uploading like nothing happened. Read more about it [on the blog](https://uppy.io/blog/2017/07/golden-retriever/).

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

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

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

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

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

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

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

@@ -1,6 +1,6 @@
 ---
 type: docs
-order: 23
+order: 51
 title: "Progress Bar"
 permalink: docs/progress-bar/
 alias: docs/progressbar/

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

@@ -2,7 +2,7 @@
 title: "Provider Plugins"
 type: docs
 permalink: docs/providers/
-order: 50
+order: 30
 ---
 
 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 (import a file by pasting a direct link to it). Because this requires server to server communication, they work tightly with [uppy-server](https://github.com/transloadit/uppy-server) 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.

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

@@ -2,7 +2,7 @@
 title: "<DashboardModal />"
 type: docs
 permalink: docs/react/dashboard-modal/
-order: 65
+order: 85
 ---
 
 The `<DashboardModal />` component wraps the [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 />"
 type: docs
 permalink: docs/react/dashboard/
-order: 64
+order: 84
 ---
 
 The `<Dashboard />` component wraps the [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
 permalink: docs/react/drag-drop/
 alias: docs/react/dragdrop/
-order: 62
+order: 82
 ---
 
 The `<DragDrop />` component wraps the [DragDrop][] plugin.

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
 title: "Redux"
 type: docs
 permalink: docs/redux
-order: 67
+order: 87
 ---
 
 Uppy supports 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
-order: 22
+order: 50
 title: "Status Bar"
 permalink: docs/status-bar/
 alias: docs/statusbar/

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

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

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

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

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

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

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

@@ -1,6 +1,6 @@
 ---
 type: docs
-order: 31
+order: 41
 title: "XHR Upload"
 permalink: docs/xhr-upload/
 alias: docs/xhrupload/

+ 13 - 0
website/themes/uppy/layout/partials/sidebar.ejs

@@ -1,7 +1,20 @@
 <%
 var categories = [
+  // order: 1x
   { path: 'docs/plugins/', name: 'Plugins', link: true },
+  // order: 2x
+  { path: 'docs/dashboard/', name: 'Local Sources', link: false },
+  // order: 3x
   { path: 'docs/providers/', name: 'Remote Providers', link: true },
+  // order: 4x
+  { path: 'docs/tus/', name: 'Uploaders', link: false },
+  // order: 5x
+  { path: 'docs/status-bar/', name: 'UI Elements', link: false },
+  // order: 6x
+  { path: 'docs/transloadit/', name: 'File Processing', link: false },
+  // order: 7x
+  { path: 'docs/form/', name: 'Miscellaneous', link: false },
+  // order: 8x
   { path: 'docs/react/', name: 'React Components', link: true },
 ]
 %>