[lxc-devel] [lxd/master] doc: Add documentation metadata

stgraber on Github lxc-bot at linuxcontainers.org
Thu Aug 15 21:10:17 UTC 2019


A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 354 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20190815/a2187b64/attachment.bin>
-------------- next part --------------
From 5cba89082862cc36ea78ff9eb482e467103a1118 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Fri, 2 Aug 2019 20:25:21 -0400
Subject: [PATCH] doc: Add documentation metadata
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: St├ęphane Graber <stgraber at ubuntu.com>
---
 doc/metadata.yaml | 108 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 doc/metadata.yaml

diff --git a/doc/metadata.yaml b/doc/metadata.yaml
new file mode 100644
index 0000000000..e38c7c5000
--- /dev/null
+++ b/doc/metadata.yaml
@@ -0,0 +1,108 @@
+navigation:
+    - title: Getting started
+      location: index.md
+      children:
+        - title: Requirements
+          location: requirements.md
+
+        - title: Frequently asked
+          location: faq.md
+
+        - title: Security
+          location: security.md
+
+        - title: Contributing
+          location: contributing.md
+
+    - title: Configuration
+      location: configuration.md
+      children:
+        - title: Containers
+          location: containers.md
+
+        - title: Networks
+          location: networks.md
+
+        - title: Preseed files
+          location: preseed.md
+
+        - title: Profiles
+          location: profiles.md
+
+        - title: Projects
+          location: projects.md
+
+        - title: Server settings
+          location: server.md
+
+        - title: Storage pools
+          location: storage.md
+
+    - title: Images
+      children:
+        - title: Architectures
+          location: architectures.md
+
+        - title: Cloud-init
+          location: cloud-init.md
+
+        - title: Handling
+          location: image-handling.md
+
+    - title: Operation
+      children:
+        - title: Backups
+          location: backup.md
+
+        - title: Clustering
+          location: clustering.md
+
+        - title: Production setup
+          location: production-setup.md
+
+    - title: REST API
+      children:
+        - title: Main API documentation
+          location: rest-api.md
+
+        - title: Main API extensions
+          location: api-extensions.md
+
+        - title: Container API documentation
+          location: dev-lxd.md
+
+    - title: Internals & debugging
+      children:
+        - title: Container environment
+          location: container-environment.md
+
+        - title: Container migration
+          location: migration.md
+
+        - title: Daemon behavior
+          location: daemon-behavior.md
+
+        - title: Database
+          location: database.md
+
+        - title: Debugging
+          location: debugging.md
+
+        - title: Environment variables
+          location: environment.md
+
+        - title: System call interception
+          location: syscall-interception.md
+
+        - title: User namespace setup
+          location: userns-idmap.md
+
+    - title: External resources
+      children:
+        - title: Project repository
+          location: https://github.com/lxc/lxd
+          external: true
+
+        - title: Image server
+          location: https://images.linuxcontainers.org
+          external: true


More information about the lxc-devel mailing list