Setup basic structure

Author: Acconut

docs/hooks.md docs/_advanced_topics/hooks.md

@@ -1,9 +1,17 @@
 ---
-title: Hooks
+title: Customizatio via Hooks
 layout: default
+nav_order: 1
 ---
 
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
 # Hooks
+{: .no_toc }
 
 When integrating tusd into an application, it is important to establish a communication channel between tusd and your main application. For this purpose, tusd provides a hook system which triggers user-defined actions when certain events happen, for example when an upload is created or finished. This simple-but-powerful system enables many uses, such as logging, validation, authorization, and post-processing of the uploaded files.
 

docs/locks.md docs/_advanced_topics/locks.md

@@ -1,6 +1,7 @@
 ---
-title: Locks
+title: Upload Locks
 layout: default
+nav_order: 2
 ---
 
 # Upload Locks

docs/monitoring.md docs/_advanced_topics/monitoring.md

@@ -1,6 +1,7 @@
 ---
-title: Monitoring
+title: Monitoring tusd
 layout: default
+nav_order: 3
 ---
 
 # Monitoring tusd

docs/usage-package.md docs/_advanced_topics/usage-package.md

@@ -1,6 +1,7 @@
 ---
-title: Usage as a package
+title: Embedding in Go programs
 layout: default
+nav_order: 4
 ---
 
 # Using the tusd package programmatically

docs/_config.yml

@@ -26,3 +26,25 @@ gh_edit_repository: "https://github.com/tus/tusd"
 gh_edit_branch: "main"
 gh_edit_source: docs
 gh_edit_view_mode: "edit"
+
+# Define Jekyll collections
+collections:
+  advanced_topics:
+    permalink: "/:collection/:path/"
+    output: true
+  storage_backends:
+    permalink: "/:collection/:path/"
+    output: true
+  getting_started:
+    permalink: "/:collection/:path/"
+    output: true
+
+just_the_docs:
+  # Define which collections are used in just-the-docs
+  collections:
+    getting_started:
+      name: Getting Started
+    storage_backends:
+      name: Storage Backends
+    advanced_topics:
+      name: Advanced Topics

docs/installation.md docs/_getting_started/installation.md

@@ -1,6 +1,7 @@
 ---
 title: Installation
 layout: default
+nav_order: 1
 ---
 
 # Installation

docs/usage-binary.md docs/_getting_started/usage-binary.md

@@ -1,6 +1,7 @@
 ---
-title: Usage as a program
+title: Usage
 layout: default
+nav_order: 2
 ---
 
 # Running tusd

docs/_storage_backends/aws-s3.md

@@ -0,0 +1,5 @@
+---
+title: AWS S3
+layout: default
+nav_order: 3
+---

docs/_storage_backends/azure-cloud-storage.md

@@ -0,0 +1,5 @@
+---
+title: Azure Cloud Storage
+layout: default
+nav_order: 4
+---

docs/_storage_backends/google-cloud-storage.md

@@ -0,0 +1,5 @@
+---
+title: Google Cloud Storage
+layout: default
+nav_order: 5
+---

docs/_storage_backends/local-disk.md

@@ -0,0 +1,5 @@
+---
+title: Local Disk
+layout: default
+nav_order: 2
+---

docs/_storage_backends/overview.md

@@ -0,0 +1,5 @@
+---
+title: Overview
+layout: default
+nav_order: 1
+---

docs/faq.md

@@ -1,6 +1,7 @@
 ---
 title: FAQ
 layout: default
+nav_order: 2
 ---
 
 # FAQ

docs/index.md

@@ -1,6 +1,7 @@
 ---
 title: Home
 layout: home
+nav_order: 1
 ---
 
 This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.