forked from aristanetworks/ansible-cvp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
148 lines (141 loc) · 4.83 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# Project information
site_name: Arista CVP collection
site_author: Arista Ansible Team
site_description: Arista Cloudvision collection's documentation
copyright: Copyright © 2019 - 2021 Arista Networks
# Repository
repo_name: CV Collection on Github
repo_url: https://github.com/aristanetworks/ansible-cvp
# Configuration
use_directory_urls: true
theme:
name: material
custom_dir: ansible_collections/arista/cvp/docs/_overrides
features:
- navigation.instant
- navigation.top
highlightjs: true
hljs_languages:
- yaml
- python
- shell
icon:
repo: fontawesome/brands/github
logo: fontawesome/solid/book
favicon: docs/_media/favicon.ico
font:
code: Fira Mono
language: en
include_search_page: false
search_index_only: true
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
extra_css:
- docs/stylesheets/extra.material.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- docs/stylesheets/tables.js
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js
- docs/stylesheets/highlight.js
plugins:
- search:
lang: en
- git-revision-date-localized:
type: date
# Deactivated due to https://github.com/tikitu/jsmin/issues/33
# Issue in progress: https://github.com/byrnereese/mkdocs-minify-plugin/issues/15
# - minify:
# minify_html: true
# minify_js: true
markdown_extensions:
- mdx_truly_sane_lists
- smarty
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- fontawesome_markdown
- admonition
- codehilite:
guess_lang: true
- toc:
separator: "-"
# permalink: "#"
permalink: true
baselevel: 3
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.snippets:
base_path: 'ansible_collections/arista/cvp/'
# TOC
docs_dir: ansible_collections/arista/cvp/
nav:
- Home: README.md
- Getting Started: docs/getting-started.md
- Release Notes:
- Versions 1.x: docs/release-notes/v1.x.md
- Versions 2.x: docs/release-notes/v2.x.md
- Versions 3.x: docs/release-notes/v3.x.md
- Installation:
- Requirements: docs/installation/requirements.md
- Configure your local environment: docs/installation/setup-environement.md
- Installation using git: docs/installation/setup-git.md
- Installation using ansible-galaxy: docs/installation/setup-galaxy.md
- Docker & Development: docs/installation/setup-docker.md
- How-To:
- CV Authentication: docs/how-to/cvp-authentication.md
- CV Modules v1:
- Get Facts: docs/how-to/v1/cv_facts.md
- Manage configlets: docs/how-to/v1/cv_configlet.md
- Manage containers: docs/how-to/v1/cv_container.md
- Manage devices: docs/how-to/v1/cv_device.md
- CV Modules v3:
- Manage configlets: docs/how-to/v3/cv_configlet_v3.md
- Manage containers: docs/how-to/v3/cv_container_v3.md
- Manage devices: docs/how-to/v3/cv_device_v3.md
- Manage tasks: docs/how-to/v3/cv_task_v3.md
- Development tips & tricks: docs/installation/development.md
- Activate logging: docs/how-to/debug.md
- Frequently Asked Questions:
- Error Messages: docs/faq/errors.md
- Roles documentation:
- DHCP Configuration role: roles/dhcp_configuration/README.md
- Cloudvision Configlet Sync: roles/configlets_sync/README.md
- Modules documentation:
- Modules version 1:
- Module cv_facts: docs/modules/cv_facts.rst/
- Module cv_configlet: docs/modules/cv_configlet.rst/
- Module cv_container: docs/modules/cv_container.rst/
- Module cv_device: docs/modules/cv_device.rst/
- Module cv_task: docs/modules/cv_task.rst/
- Module version 3:
- Module cv_configlet_v3: docs/modules/cv_configlet_v3.rst.md
- Module cv_container_v3: docs/modules/cv_container_v3.rst.md
- Module cv_device_v3: docs/modules/cv_device_v3.rst.md
- Module cv_task_v3: docs/modules/cv_task_v3.rst.md
- External resources:
- Ansible collection user guide: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html
- Ansible User guide: https://docs.ansible.com/ansible/latest/user_guide/index.html
- About:
- Ansible Galaxy page: https://galaxy.ansible.com/arista/cvp
- Arista Validated Design Collection: https://www.avd.sh
- Arista Automation Examples: https://aristanetworks.github.io/netdevops-examples/