forked from Azure/PSRule.Rules.Azure
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
executable file
·182 lines (169 loc) · 5.35 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
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
site_name: PSRule for Azure
site_url: https://azure.github.io/PSRule.Rules.Azure
site_description: Ready to go rules for testing Azure Infrastructure as Code (IaC).
site_author: Microsoft
repo_url: https://github.com/Azure/PSRule.Rules.Azure/
edit_uri: blob/main/docs/
repo_issue: https://github.com/Azure/PSRule.Rules.Azure/issues
repo_discussion: https://github.com/Azure/PSRule.Rules.Azure/discussions
extra_css:
- assets/stylesheets/extra.css
theme:
language: en
name: material
custom_dir: overrides
font:
text: Roboto
palette:
primary: black
accent: blue
logo: assets/ms_icon.png
favicon: assets/ms_icon.png
icon:
repo: fontawesome/brands/github
features:
- navigation.instant
- navigation.indexes
- navigation.sections:
level: 1
- navigation.tabs
- navigation.footer
- content.code.annotate
- content.tabs.link
- content.code.copy
- content.action.edit
- content.action.view
nav:
- Home: index.md
- Getting started:
- Overview:
- About: about.md
- Features: features.md
- FAQ: faq.md
- Install: install.md
- Quickstarts:
- Test a Bicep deployment:
- With GitHub Actions: quickstarts/test-bicep-with-github.md
# - With Visual Studio Code: quickstarts/test-bicep-with-vscode.md
# - Tutorials:
- Testing infrastructure code:
- Expanding source files: expanding-source-files.md
- Using templates: using-templates.md
- Using Bicep source: using-bicep.md
- Creating your pipeline: creating-your-pipeline.md
- Working with baselines: working-with-baselines.md
- Testing deployed resources:
- Exporting rule data: export-rule-data.md
- Analyzing resources: analyzing-resources.md
- Concepts:
- Suppression: concepts/suppression.md
- Policy as rules: concepts/policy-as-rules.md
- Customization:
- Using custom rules: customization/using-custom-rules.md
- Enforcing custom tags: customization/enforce-custom-tags.md
- Enforcing code ownership: customization/enforce-codeowners.md
- Permit outbound management: customization/permit-outbound-management.md
- Troubleshooting: troubleshooting.md
- Samples: samples.md
- License and contributing:
- Index: license-contributing/index.md
- Writing documentation: license-contributing/writing-documentation.md
- Past hackathons: license-contributing/hackathons.md
- Related projects: related-projects.md
- Releases:
- Change log:
- v1: 'CHANGELOG-v1.md'
- v0: 'CHANGELOG-v0.md'
- Upgrade notes: upgrade-notes.md
- Deprecations: deprecations.md
- Changes and versioning: versioning.md
- Support: support.md
- Setup:
- Configuring options:
- Index: setup/index.md
- Configuring rule defaults: setup/configuring-rules.md
- Configuring expansion: setup/configuring-expansion.md
- Configuring exports: setup/configuring-exports.md
- Setup Bicep: setup/setup-bicep.md
- Setup Azure Monitor logs: setup/setup-azure-monitor-logs.md
- Integrations: integrations.md
- Reference:
- Index: en/rules/index.md
- By pillar: en/rules/module.md
- By resource: en/rules/resource.md
- Microsoft Cloud Security Benchmark: en/mcsb-v1.md
- Learn:
- Learn PSRule for Azure series: learn/learn-video-series.md
- Official learning: learn/official.md
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- pymdownx.snippets
- pymdownx.highlight:
auto_title: false
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences
- pymdownx.pathconverter
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- mdx_truly_sane_lists
- pymdownx.tasklist
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
permalink: '#'
separator: '-'
plugins:
- git-revision-date-localized:
enable_creation_date: true
fallback_to_build_date: true
- git-committers:
enabled: !ENV [GITHUB_ACTIONS, false]
repository: Azure/PSRule.Rules.Azure
branch: main
- search
- tags:
tags: false
- redirects:
redirect_maps:
install-instructions.md: install.md
validating-locally.md: install.md
using-metadata.md: using-templates.md
customization/index.md: customization/using-custom-rules.md
customization/storing-custom-rules.md: customization/using-custom-rules.md
en/asb-v3.md: en/mcsb-v1.md
setup/configuring-options.md: setup/index.md
hooks:
- docs/hooks/shortcodes.py
- docs/hooks/metadata.py
- docs/hooks/aliases.py
- docs/hooks/old_hooks.py
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Azure/PSRule.Rules.Azure/
local:
social_preview: https://repository-images.githubusercontent.com/184154668/58818c00-d496-11eb-9b77-016145022654
giscus:
repo: Azure/PSRule.Rules.Azure
repo_id: MDEwOlJlcG9zaXRvcnkxODQxNTQ2Njg=
category: Documentation
category_id: DIC_kwDOCvn6LM4CQqE6
# alternate:
# - name: English
# link: /PSRule.Rules.Azure/en/
# lang: en
# - name: Spanish
# link: /PSRule.Rules.Azure/es/
# lang: es