forked from oscal-compass/compliance-trestle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
141 lines (141 loc) · 6.07 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
extra_css:
- css/extra.css
google_analytics:
- G-XT3KGMHSY8
- auto
markdown_extensions:
- admonition
- markdown_include.include
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- toc:
permalink: "\xA4"
nav:
- Overview: index.md
- Trestle cli:
- Overview: cli.md
- Markdown: trestle_md.md
- Tutorials:
- Overview: tutorials/tutorials.md
- setting up python and trestle: tutorials/python_trestle_setup.md
- intro to trestle workflow: tutorials/trestle_sample_workflow.md
- compliance posture: tutorials/continuous-compliance/continuous-compliance.md
- transformer construction: tutorials/task.transformer-construction/transformer-construction.md
- task tanium-to-oscal: tutorials/task.tanuim-to-oscal/transformation.md
- third party result schema for SCC: tutorials/third-party-result-schema-SCC.md
- Code of Conduct: mkdocs_code_of_conduct.md
- Contributing:
- Overview: contributing/mkdocs_contributing.md
- Contributors: https://github.com/IBM/compliance-trestle/graphs/contributors
- Maintainers: maintainers.md
- Documentation website: contributing/website.md
- Developer Certificate of Originality: contributing/DCO.md
- Known limitations: errors.md
- Reference:
- Overview: api_overview.md
- trestle:
- tasks:
- base_task: api_reference/trestle.tasks.base_task.md
- transform: api_reference/trestle.tasks.transform.md
- osco_to_oscal: api_reference/trestle.tasks.osco_to_oscal.md
- tanium_to_oscal: api_reference/trestle.tasks.tanium_to_oscal.md
- core:
- validator: api_reference/trestle.core.validator.md
- validator_helper: api_reference/trestle.core.validator_helper.md
- models:
- interfaces: api_reference/trestle.core.models.interfaces.md
- elements: api_reference/trestle.core.models.elements.md
- actions: api_reference/trestle.core.models.actions.md
- plans: api_reference/trestle.core.models.plans.md
- file_content_type: api_reference/trestle.core.models.file_content_type.md
- base_model: api_reference/trestle.core.base_model.md
- duplicates_validator: api_reference/trestle.core.duplicates_validator.md
- generators: api_reference/trestle.core.generators.md
- ncname_validator: api_reference/trestle.core.ncname_validator.md
- parser: api_reference/trestle.core.parser.md
- all_validator: api_reference/trestle.core.all_validator.md
- utils: api_reference/trestle.core.utils.md
- commands:
- md: api_reference/trestle.core.commands.md.md
- task: api_reference/trestle.core.commands.task.md
- merge: api_reference/trestle.core.commands.merge.md
- cmd_utils: api_reference/trestle.core.commands.cmd_utils.md
- version: api_reference/trestle.core.commands.version.md
- add: api_reference/trestle.core.commands.add.md
- create: api_reference/trestle.core.commands.create.md
- md_subs:
- cidd: api_reference/trestle.core.commands.md_subs.cidd.md
- governed_docs: api_reference/trestle.core.commands.md_subs.governed_docs.md
- governed_folders: api_reference/trestle.core.commands.md_subs.governed_folders.md
- replicate: api_reference/trestle.core.commands.replicate.md
- remove: api_reference/trestle.core.commands.remove.md
- command_docs: api_reference/trestle.core.commands.command_docs.md
- assemble: api_reference/trestle.core.commands.assemble.md
- validate: api_reference/trestle.core.commands.validate.md
- split: api_reference/trestle.core.commands.split.md
- import_: api_reference/trestle.core.commands.import_.md
- init: api_reference/trestle.core.commands.init.md
- object_factory: api_reference/trestle.core.object_factory.md
- err: api_reference/trestle.core.err.md
- const: api_reference/trestle.core.const.md
- refs_validator: api_reference/trestle.core.refs_validator.md
- markdown_validator: api_reference/trestle.core.markdown_validator.md
- validator_factory: api_reference/trestle.core.validator_factory.md
- remote:
- cache: api_reference/trestle.core.remote.cache.md
- utils:
- log: api_reference/trestle.utils.log.md
- osco: api_reference/trestle.utils.osco.md
- load_distributed: api_reference/trestle.utils.load_distributed.md
- trash: api_reference/trestle.utils.trash.md
- fs: api_reference/trestle.utils.fs.md
- oscal:
- catalog: api_reference/trestle.oscal.catalog.md
- poam: api_reference/trestle.oscal.poam.md
- profile: api_reference/trestle.oscal.profile.md
- assessment_results: api_reference/trestle.oscal.assessment_results.md
- target: api_reference/trestle.oscal.target.md
- ssp: api_reference/trestle.oscal.ssp.md
- component: api_reference/trestle.oscal.component.md
- assessment_plan: api_reference/trestle.oscal.assessment_plan.md
- transforms:
- transformer_factory: api_reference/trestle.transforms.transformer_factory.md
- results: api_reference/trestle.transforms.results.md
- transformer_singleton: api_reference/trestle.transforms.transformer_singleton.md
- utils:
- tanium_helper: api_reference/trestle.transforms.utils.tanium_helper.md
- implementations:
- tanium: api_reference/trestle.transforms.implementations.tanium.md
- cli: api_reference/trestle.cli.md
plugins:
- search
- mkdocstrings:
handlers:
python:
rendering:
group_by_category: true
show_category_heading: true
show_if_no_docstring: true
show_root_heading: true
selection:
filters:
- '!^_[^_]'
- '!^__json'
- '!^__config__'
new_path_syntax: true
watch:
- trestle
repo_name: IBM/compliance-trestle
repo_url: https://github.com/IBM/compliance-trestle
site_description: Documentation for compliance-trestle package.
site_name: Compliance Trestle
site_url: https://ibm.github.io/compliance-trestle
theme:
name: material
palette:
accent: purple
primary: teal
scheme: slate