-
Notifications
You must be signed in to change notification settings - Fork 188
/
mkdocs.yml
66 lines (62 loc) · 2.41 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
site_name: Cloudsplaining
#theme: readthedocs
#use_directory_urls: false
site_url: https://cloudsplaining.readthedocs.io/
repo_url: https://github.com/salesforce/cloudsplaining
theme: material
use_directory_urls: true
markdown_extensions:
- codehilite
- tables
- admonition
- pymdownx.details
- pymdownx.superfences
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: true
watch:
- cloudsplaining/
nav:
- "<b>Home</b>": 'index.md'
- "<b>User Guide</b>":
- Introduction: 'user-guide/overview.md'
- Installation: 'user-guide/installation.md'
- Downloading Account IAM Details: 'user-guide/download.md'
- Creating an Exclusions File: 'user-guide/create-exclusions-file.md'
- Scanning a single AWS account: 'user-guide/scan-account.md'
- Scanning a single policy: 'user-guide/scan-policy-file.md'
- Scanning multiple AWS accounts: 'user-guide/scan-multiple-accounts.md'
- Troubleshooting: 'user-guide/troubleshooting.md'
- "<b>Report Contents</b>":
- Overview: 'report/overview.md'
- Triage: 'report/triage.md'
- Remediation: 'report/remediation.md'
- Validation: 'report/validation.md'
- "<b>Glossary</b>":
- Privilege Escalation: 'glossary/privilege-escalation.md'
- Resource Exposure: 'glossary/resource-exposure.md'
- Data Exfiltration: 'glossary/data-exfiltration.md'
- Credentials Exposure: 'glossary/credentials-exposure.md'
- Infrastructure Modification: 'glossary/infrastructure-modification.md'
- Service Wildcard: 'glossary/service-wildcard.md'
- Roles Assumable by Compute Service: 'glossary/roles-assumable-by-compute-service.md'
- Trust Policy: 'glossary/trust-policy.md'
- "<b>Contributing</b>":
- Contributing: 'contributing/contributing.md'
- Documentation: 'contributing/documentation.md'
- JavaScript: 'contributing/javascript.md'
- Python: 'contributing/python.md'
- JSON Schema: 'contributing/results-json-schema.md'
- Release Drafter: 'contributing/release-drafter.md'
- Report Generation: 'contributing/report.md'
- Testing: 'contributing/testing.md'
- Versioning: 'contributing/versioning.md'
- "<b>Appendices</b>":
- FAQ: 'appendices/faq.md'
- Comparison to other tools: 'appendices/comparison-to-other-tools.md'
- Jira Ticket Automation: 'appendices/jira-ticket-automation.md'