-
Notifications
You must be signed in to change notification settings - Fork 11
/
mkdocs.yml
233 lines (226 loc) · 11.5 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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# Project Information
site_name: VMware.CloudFoundation.Reporting
site_description: PowerShell Module for VMware Cloud Foundation Reporting
site_url: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting/
site_author: Broadcom
docs_dir: docs
site_dir: .site
use_directory_urls: true
# Repository
repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting
edit_uri: blob/main/docs/
# Copyright
copyright: |
Copyright © 2005-2024 Broadcom. All Rights Reserved.<br/>
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.<br/><br/>
# Configuration
theme:
name: material
favicon: favicon.ico
logo: assets/images/icon-white.svg
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Dark Theme
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Light Theme
font:
text: Roboto
code: Roboto Mono
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.header
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# Plugins
plugins:
- search:
separator: '[\s\u200b\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- open-in-new-tab
- markdownextradata:
jinja_options:
variable_start_string: "${{"
variable_end_string: "}}"
- git-revision-date-localized:
enabled: !ENV [CI, false]
enable_creation_date: false
exclude:
- index.md
fallback_to_build_date: true
type: timeago
# Customization
extra:
config:
repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting
repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting
version:
default: latest
provider: mike
extra_css:
- assets/stylesheets/extra.css
# Extensions
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- material/.icons
- pymdownx.inlinehilite
- pymdownx.highlight:
use_pygments: true
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- tables
- toc:
permalink: true
# Navigation
nav:
- Getting Started:
- index.md
- Installation: install.md
- Updating: update.md
- User Access: user-access.md
- Release Notes: release-notes.md
- Release Milestones: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/milestones
- License: license.md
- Reference:
- User Guide:
- Overview Reports: documentation/getting-started/overview-report.md
- Health Reports: documentation/getting-started/health-report.md
- Alert Reports: documentation/getting-started/alert-report.md
- Configuration Reports: documentation/getting-started/configuration-report.md
- Upgrade Reports: documentation/getting-started/upgrade-precheck-report.md
- Functions:
- Copy-FiletoSddc: documentation/functions/Copy-FiletoSddc.md
- Invoke-SddcCommand: documentation/functions/Invoke-SddcCommand.md
- Invoke-VcfAlertReport: documentation/functions/Invoke-VcfAlertReport.md
- Invoke-VcfConfigReport: documentation/functions/Invoke-VcfConfigReport.md
- Invoke-VcfHealthReport: documentation/functions/Invoke-VcfHealthReport.md
- Invoke-VcfOverviewReport: documentation/functions/Invoke-VcfOverviewReport.md
- Invoke-VcfUpgradePrecheck: documentation/functions/Invoke-VcfUpgradePrecheck.md
- Publish-BackupStatus: documentation/functions/Publish-BackupStatus.md
- Publish-CertificateHealth: documentation/functions/Publish-CertificateHealth.md
- Publish-ClusterConfiguration: documentation/functions/Publish-ClusterConfiguration.md
- Publish-ClusterDrsRule: documentation/functions/Publish-ClusterDrsRule.md
- Publish-ComponentConnectivityHealth: documentation/functions/Publish-ComponentConnectivityHealth.md
- Publish-ComponentConnectivityHealthNonSOS: documentation/functions/Publish-ComponentConnectivityHealthNonSOS.md
- Publish-ConnectivityHealth: documentation/functions/Publish-ConnectivityHealth.md
- Publish-DnsHealth: documentation/functions/Publish-DnsHealth.md
- Publish-EsxiAlert: documentation/functions/Publish-EsxiAlert.md
- Publish-EsxiConnectionHealth: documentation/functions/Publish-EsxiConnectionHealth.md
- Publish-EsxiCoreDumpConfig: documentation/functions/Publish-EsxiCoreDumpConfig.md
- Publish-EsxiHealth: documentation/functions/Publish-EsxiHealth.md
- Publish-EsxiSecurityConfiguration: documentation/functions/Publish-EsxiSecurityConfiguration.md
- Publish-HardwareCompatibilityHealth: documentation/functions/Publish-HardwareCompatibilityHealth.md
- Publish-NsxtAlert: documentation/functions/Publish-NsxtAlert.md
- Publish-NsxtCombinedHealth: documentation/functions/Publish-NsxtCombinedHealth.md
- Publish-NsxtEdgeClusterHealth: documentation/functions/Publish-NsxtEdgeClusterHealth.md
- Publish-NsxtEdgeNodeHealth: documentation/functions/Publish-NsxtEdgeNodeHealth.md
- Publish-NsxtHealth: documentation/functions/Publish-NsxtHealth.md
- Publish-NsxtHealthNonSOS: documentation/functions/Publish-NsxtHealthNonSOS.md
- Publish-NsxtTier0BgpStatus: documentation/functions/Publish-NsxtTier0BgpStatus.md
- Publish-NsxtTransportNodeStatus: documentation/functions/Publish-NsxtTransportNodeStatus.md
- Publish-NsxtTransportNodeTunnelStatus: documentation/functions/Publish-NsxtTransportNodeTunnelStatus.md
- Publish-NtpHealth: documentation/functions/Publish-NtpHealth.md
- Publish-PasswordHealth: documentation/functions/Publish-PasswordHealth.md
- Publish-PingConnectivityHealth: documentation/functions/Publish-PingConnectivityHealth.md
- Publish-ResourcePool: documentation/functions/Publish-ResourcePool.md
- Publish-SddcManagerFreePool: documentation/functions/Publish-SddcManagerFreePool.md
- Publish-ServiceHealth: documentation/functions/Publish-ServiceHealth.md
- Publish-SnapshotStatus: documentation/functions/Publish-SnapshotStatus.md
- Publish-StorageCapacityHealth: documentation/functions/Publish-StorageCapacityHealth.md
- Publish-VcenterAlert: documentation/functions/Publish-VcenterAlert.md
- Publish-VcenterHealth: documentation/functions/Publish-VcenterHealth.md
- Publish-VcfSystemOverview: documentation/functions/Publish-VcfSystemOverview.md
- Publish-VersionHealth: documentation/functions/Publish-VersionHealth.md
- Publish-VirtualNetwork: documentation/functions/Publish-VirtualNetwork.md
- Publish-VmConnectedCdrom: documentation/functions/Publish-VmConnectedCdrom.md
- Publish-VmOverride: documentation/functions/Publish-VmOverride.md
- Publish-VsanAlert: documentation/functions/Publish-VsanAlert.md
- Publish-VsanHealth: documentation/functions/Publish-VsanHealth.md
- Publish-VsanStoragePolicy: documentation/functions/Publish-VsanStoragePolicy.md
- Request-ClusterConfiguration: documentation/functions/Request-ClusterConfiguration.md
- Request-ClusterDrsRule: documentation/functions/Request-ClusterDrsRule.md
- Request-ClusterOverview: documentation/functions/Request-ClusterOverview.md
- Request-DatastoreStorageCapacity: documentation/functions/Request-DatastoreStorageCapacity.md
- Request-EsxiAlert: documentation/functions/Request-EsxiAlert.md
- Request-EsxiConnectionHealth: documentation/functions/Request-EsxiConnectionHealth.md
- Request-EsxiOverview: documentation/functions/Request-EsxiOverview.md
- Request-EsxiSecurityConfiguration: documentation/functions/Request-EsxiSecurityConfiguration.md
- Request-EsxiStorageCapacity: documentation/functions/Request-EsxiStorageCapacity.md
- Request-HardwareOverview: documentation/functions/Request-HardwareOverview.md
- Request-NetworkOverview: documentation/functions/Request-NetworkOverview.md
- Request-NsxtAlert: documentation/functions/Request-NsxtAlert.md
- Request-NsxtAuthentication: documentation/functions/Request-NsxtAuthentication.md
- Request-NsxtComputeManagerStatus: documentation/functions/Request-NsxtComputeManagerStatus.md
- Request-NsxtEdgeSnapshotStatus: documentation/functions/Request-NsxtEdgeSnapshotStatus.md
- Request-NsxtManagerBackupStatus: documentation/functions/Request-NsxtManagerBackupStatus.md
- Request-NsxtTier0BgpStatus: documentation/functions/Request-NsxtTier0BgpStatus.md
- Request-NsxtTransportNodeStatus: documentation/functions/Request-NsxtTransportNodeStatus.md
- Request-NsxtTransportNodeTunnelStatus: documentation/functions/Request-NsxtTransportNodeTunnelStatus.md
- Request-NsxtVidmStatus: documentation/functions/Request-NsxtVidmStatus.md
- Request-ResourcePool: documentation/functions/Request-ResourcePool.md
- Request-SddcManagerBackupStatus: documentation/functions/Request-SddcManagerBackupStatus.md
- Request-SddcManagerFreePool: documentation/functions/Request-SddcManagerFreePool.md
- Request-SddcManagerSnapshotStatus: documentation/functions/Request-SddcManagerSnapshotStatus.md
- Request-SddcManagerStorageHealth: documentation/functions/Request-SddcManagerStorageHealth.md
- Request-SosHealthJson: documentation/functions/Request-SoSHealthJson.md
- Request-ValidatedSolutionsOverview: documentation/functions/Request-ValidatedSolutionOverview.md
- Request-VcenterAlert: documentation/functions/Request-VcenterAlert.md
- Request-VcenterAuthentication: documentation/functions/Request-VcenterAuthentication.md
- Request-VcenterBackupStatus: documentation/functions/Request-VcenterBackupStatus.md
- Request-VcenterOverview: documentation/functions/Request-VcenterOverview.md
- Request-VcenterSnapshotStatus: documentation/functions/Request-VcenterSnapshotStatus.md
- Request-VcenterStorageHealth: documentation/functions/Request-VcenterStorageHealth.md
- Request-VcfOverview: documentation/functions/Request-VcfOverview.md
- Request-VirtualNetwork: documentation/functions/Request-VirtualNetwork.md
- Request-VmConnectedCdrom: documentation/functions/Request-VmConnectedCdrom.md
- Request-VmOverride: documentation/functions/Request-VmOverride.md
- Request-VMwareAriaSuiteOverview: documentation/functions/Request-VMwareAriaSuiteOverview.md
- Request-VsanAlert: documentation/functions/Request-VsanAlert.md
- Test-VcfReportingPrereq: documentation/functions/Test-VcfReportingPrereq.md
- Community:
- community/index.md
- Contributing: community/contributing.md
- Discussions: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/discussions
- Search Issues: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/issues
- Open an Issue: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/issues/new/choose
- Support: community/support.md
- Code of Conduct: community/code-of-conduct.md