forked from aristanetworks/ansible-cvp
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
170 lines (162 loc) · 5.48 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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# Project information
site_name: Arista CVP collection
site_author: Arista Ansible Team
site_description: Arista CloudVision collection's documentation
copyright: Copyright © 2019 - 2022 Arista Networks
# Repository
repo_name: CV Collection on Github
repo_url: https://github.com/aristanetworks/ansible-cvp
# Configuration
use_directory_urls: true
edit_uri: edit/devel/ansible_collections/arista/cvp/
theme:
name: material
custom_dir: ansible_collections/arista/cvp/docs/_overrides
features:
- navigation.instant
- navigation.top
- search.highlight
- header.autohide
- content.code.annotate
- content.tabs.link
highlightjs: true
icon:
repo: fontawesome/brands/github
logo: fontawesome/solid/book
edit: fontawesome/solid/file-pen
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/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/aristanetworks/ansible-cvp
- icon: fontawesome/brands/twitter
link: https://twitter.com/AristaNetworks
- icon: fontawesome/solid/globe
link: https://www.arista.com
extra_css:
- docs/stylesheets/extra.material.css
extra_javascript:
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- docs/stylesheets/tables.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:
- admonition
- attr_list
- mdx_truly_sane_lists
- smarty
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols:
fractions: false
- pymdownx.snippets:
base_path: 'ansible_collections/arista/cvp/'
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- tables
- toc:
separator: "-"
# permalink: "#"
permalink: true
baselevel: 3
# TOC
docs_dir: ansible_collections/arista/cvp/
nav:
- Home: README.md
- Getting Started: docs/getting-started.md
- Installation:
- Collection Installation: docs/installation/collection-installation.md
- Requirements: docs/installation/requirements.md
- How-To:
- CV Authentication: docs/how-to/cvp-authentication.md
- Development tips & tricks: docs/installation/collection-installation.md
- Activate logging: docs/how-to/debug.md
- Schema documentation:
- CV Modules v3:
# - cv_configlet_v3: docs/schema/cv_tag_v3.md
- cv_container_v3: docs/schema/cv_container_v3.md
- cv_device_v3: docs/schema/cv_device_v3.md
# - cv_task_v3: docs/schema/cv_task_v3.md
# - cv_facts_v3: docs/schema/cv_facts_v3.md
# - cv_image_v3: docs/schema/cv_image_v3.md
- cv_tag_v3: docs/schema/cv_tag_v3.md
- cv_change_control_v3: docs/schema/cv_change_control_v3.md
- cv_validate_v3: docs/schema/cv_validate_v3.md
- Frequently Asked Questions:
- Error Messages: docs/faq/errors.md
- Ansible Execution Environment: docs/faq/containers.md
- Roles documentation:
- DHCP Configuration role: roles/dhcp_configuration/README.md
- CloudVision Configlet Sync: roles/configlets_sync/README.md
- Modules documentation:
- Modules version 1:
- cv_facts: docs/modules/cv_facts.md
- cv_configlet: docs/modules/cv_configlet.md
- cv_container: docs/modules/cv_container.md
- cv_device: docs/modules/cv_device.md
- cv_task: docs/modules/cv_task.md
- Module version 3:
- cv_configlet_v3: docs/modules/cv_configlet_v3.md
- cv_container_v3: docs/modules/cv_container_v3.md
- cv_device_v3: docs/modules/cv_device_v3.md
- cv_task_v3: docs/modules/cv_task_v3.md
- cv_facts_v3: docs/modules/cv_facts_v3.md
- cv_image_v3: docs/modules/cv_image_v3.md
- cv_tag_v3: docs/modules/cv_tag_v3.md
- cv_change_control_v3: docs/modules/cv_change_control_v3.md
- cv_validate_v3: docs/modules/cv_validate_v3.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
- 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
- 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/