forked from daos-stack/daos
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
118 lines (112 loc) · 4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# Project Information
site_name: DAOS v2.3 - master
site_description: Distributed Asynchronous Object Storage
site_author: DAOS Project
# Repository
repo_name: daos-stack/daos
repo_url: https://github.com/daos-stack/daos
# edit_uri: blob/release/2.4/docs/
edit_uri: blob/master/docs/
copyright: Copyright 2016-2022 Intel Corporation
# Theme
theme:
name: 'material'
logo: daos_logo_wh.png
favicon: daos_logo_wh.png
font:
text: Ubuntu
code: Roboto Mono
language: en
palette:
primary: light blue
accent: blue
scheme: default
include_search_page: false
search_index_only: true
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant
- navigation.top
- navigation.indexes
- toc.integrate
- search.suggest
- search.highlight
extra:
homepage: https://docs.daos.io/
version:
provider: mike
plugins:
- search
- mike:
version_selector: true
markdown_extensions:
- admonition
- footnotes
- tables
- toc:
permalink: true
toc_depth: 4
# Page tree
nav:
- Intro:
- 'index.md'
- 'Community Wiki': 'https://wiki.daos.io/'
- 'Community Roadmap': 'https://wiki.daos.io/spaces/DC/pages/4836661105/Roadmap'
- 'Community Mailing list': 'https://daos.groups.io/g/daos'
- 'DAOS in the Cloud': 'cloud/index.md'
- 'Issue tracker': 'https://jira.daos.io/'
- Release Information:
- 'Release Notes v2.4': 'release/release_notes.md'
- 'Support Matrix v2.4': 'release/support_matrix.md'
- 'Upgrading to v2.4': 'release/upgrading.md'
- 'Roadmap': 'https://wiki.daos.io/spaces/DC/pages/4836661105/Roadmap'
- Overview:
- 'Architecture': 'overview/architecture.md'
- 'Storage Model': 'overview/storage.md'
- 'Transaction Model': 'overview/transaction.md'
- 'Data Integrity': 'overview/data_integrity.md'
- 'Fault Model': 'overview/fault.md'
- 'Security Model': 'overview/security.md'
- 'Use Cases': 'overview/use_cases.md'
- 'Terminology': 'overview/terminology.md'
- Installation and Setup:
- 'RHEL and clones': 'QSG/setup_rhel.md'
- 'SUSE': 'QSG/setup_suse.md'
- 'DAOS in Docker': 'QSG/docker.md'
- 'DAOS in the Cloud': 'QSG/cloud.md'
- 'Build from Scratch': 'QSG/build_from_scratch.md'
- 'Admin/Client Tools': 'QSG/tour.md'
- Administration Guide:
- 'Hardware Requirements': 'admin/hardware.md'
- 'Pre-deployment Checklist': 'admin/predeployment_check.md'
- 'System Deployment': 'admin/deployment.md'
- 'System Administration': 'admin/administration.md'
- 'Pool Operations': 'admin/pool_operations.md'
- 'Tiering and Unified Namespace': 'admin/tiering_uns.md'
- 'Performance Tuning': 'admin/performance_tuning.md'
- 'Troubleshooting': 'admin/troubleshooting.md'
- 'Environment Variables': 'admin/env_variables.md'
- Test and Benchmarking:
- 'Run DAOS Autotest': 'testing/autotest.md'
- 'Run IOR and mdtest': 'testing/ior.md'
- 'Run dbench': 'testing/dbench.md'
- 'Run Datamover test': 'testing/datamover.md'
- 'Run IO500': 'https://wiki.daos.io/spaces/DC/pages/4873388103/DAOS+IO-500+Instructions'
- User Guide:
- 'Workflow': 'user/workflow.md'
- 'Container Management': 'user/container.md'
- 'File System': 'user/filesystem.md'
- 'MPI-IO Support': 'user/mpi-io.md'
- 'HDF5 Support': 'user/hdf5.md'
- 'Python Support': 'user/python.md'
- 'Spark and Hadoop': 'user/spark.md'
- 'Data Mover': 'user/datamover.md'
- 'Tensorflow-IO Support': 'user/tensorflow.md'
- 'Native Programming Interface': 'user/interface.md'
- Developer Zone:
- 'Dev Environment': 'dev/development.md'
- 'Contributing': 'dev/contributing.md'
- 'DAOS Internals': 'https://github.com/daos-stack/daos/blob/master/src/README.md'
- 'DAOS API Documentation': 'https://docs.daos.io/v2.3/doxygen/html/index.html'
# Attention: Don't change that doxygen path to a relative path, or mkdocs will stumble...