Files
xen-orchestra/docs/.vuepress/config.js
2020-05-23 22:16:58 +02:00

108 lines
4.0 KiB
JavaScript

module.exports = {
title: 'XO documentation',
description: 'Official Xen Orchestra documentation',
head: [
[
'link',
{
rel: 'shortcut icon',
href: 'https://xen-orchestra.com/assets/favicon.ico',
},
],
],
base: '/docs/',
themeConfig: {
smoothScroll: true,
logo: 'https://xen-orchestra.com/blog/content/images/2017/05/xo-logo.png',
lastUpdated: 'Last Updated', // add latest Git commit modification for each file
repo: 'vatesfr/xen-orchestra', // point to the GH repo
editLinks: true, // display link for people to edit a page
editLinkText: 'Help us to improve this page!', // link text
docsDir: 'docs',
nav: [
{ text: 'Home', link: 'https://xen-orchestra.com' },
{ text: 'News', link: 'https://xen-orchestra.com/blog' },
{ text: 'Documentation', link: '/' },
],
sidebar: [
{
title: 'Xen Orchestra', // required
path: '/', // optional, link of the title, which should be an absolute path and must exist
collapsable: false, // optional, defaults to true
sidebarDepth: 1, // optional, defaults to 1
children: [
['/releases', 'Releases'],
['/supported_hosts', 'Host Compatibility List'],
['/installation', 'Installation'],
['/configuration', 'Configuration'],
['/updater', 'Updates'],
['/architecture', 'Architecture'],
['/troubleshooting', 'Troubleshooting'],
],
},
{
title: 'Management', // required
path: '/manage', // optional, link of the title, which should be an absolute path and must exist
collapsable: false, // optional, defaults to true
sidebarDepth: 1, // optional, defaults to 1
children: [
['/manage_infrastructure', 'Infrastructure'],
['/users', 'Users'],
['/advanced', 'Advanced features'],
['/load_balancing', 'VM Load Balancing'],
['/sdn_controller', 'SDN Controller'],
['/xosan', 'XOSANv1'],
['/xosanv2', 'XOSANv2'],
],
},
{
title: 'Backup', // required
path: '/backup', // optional, link of the title, which should be an absolute path and must exist
collapsable: false, // optional, defaults to true
sidebarDepth: 1, // optional, defaults to 1
children: [
['/backups', 'Concepts'],
['/proxy', 'Proxy'],
['/rolling_snapshots', 'Snapshots'],
['/full_backups', 'Full backup'],
['/delta_backups', 'Delta Backup'],
['/disaster_recovery.md', 'Disaster Recovery'],
['/continuous_replication', 'Continuous Replication'],
['/metadata_backup', 'Metadata Backup'],
['/backup_reports', 'Backup Reports'],
['/backup_troubleshooting', 'Backup Troubleshooting'],
],
},
{
title: 'Support', // required
path: '/support', // optional, link of the title, which should be an absolute path and must exist
collapsable: false, // optional, defaults to true
sidebarDepth: 1, // optional, defaults to 1
children: [
['/xoa', 'XOA Support'],
['/purchase', 'Purchase XOA'],
['/license_management', 'License Management'],
['/community', 'Community Support'],
],
},
{
title: 'Project', // required
path: '/project', // optional, link of the title, which should be an absolute path and must exist
collapsable: false, // optional, defaults to true
sidebarDepth: 1, // optional, defaults to 1
children: [
[
'https://github.com/vatesfr/xen-orchestra/blob/master/CHANGELOG.md#changelog',
'Changelog',
],
['/code_of_conduct', 'Code of Conduct'],
['/contributing', 'Contributing'],
['/licenses', 'Licenses'],
['/roadmap', 'Roadmap'],
['/glossary', 'Glossary'],
],
},
],
},
}