forked from oscal-compass/compliance-trestle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
249 lines (249 loc) · 12.7 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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
edit_uri: ''
extra:
analytics:
property: G-XT3KGMHSY8
provider: google
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well as
to measure the effectiveness of our documentation and whether users find what
they're searching for. With your consent, you're helping us to make our documentation
better.
markdown_extensions:
- admonition
- markdown_include.include
- md_in_html
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets
- toc:
permalink: ¤
nav:
- Overview: index.md
- Installation: python_trestle_setup.md
- Tutorials:
- Intro to trestle workflow: tutorials/trestle_sample_workflow.md
- Compliance posture: tutorials/continuous-compliance/continuous-compliance.md
- Trestle Authoring:
- Governance of Authored Documents: trestle_author.md
- Catalog, Profile, ComponentDefinition, and SSP Authoring: tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring.md
- Trestle Transformers and Tasks:
- Transformer construction: tutorials/task.transformer-construction/transformer-construction.md
- Task - task.csv-to-oscal-cd: tutorials/task.csv-to-oscal-cd/transformation.md
- Task - ocp4-cis-profile-to-oscal-catalog: tutorials/task.ocp4-cis-profile-to-oscal-catalog/transformation.md
- Task - ocp4-cis-profile-to-oscal-cd: tutorials/task.ocp4-cis-profile-to-oscal-cd/transformation.md
- Task - tanium-result-to-oscal-ar: tutorials/task.tanium-result-to-oscal-ar/transformation.md
- Trestle command-line interface (CLI):
- CLI for OSCAL documents: cli.md
- CLI for Jinja Template processing: trestle_author_jinja.md
- Contributing:
- Code of Conduct: mkdocs_code_of_conduct.md
- Contributing overview: contributing/mkdocs_contributing.md
- Contributors: https://github.com/oscal-compass/compliance-trestle/graphs/contributors
- Maintainers: maintainers.md
- Documentation website: contributing/website.md
- Trestle's object model: contributing/trestle_oscal_object_model.md
- Developer Certificate of Originality: contributing/DCO.md
- Trestle plugin mechanism: contributing/plugins.md
- GitHub actions setup: contributing/github_actions_setup.md
- Known limitations: errors.md
- Demos: demonstrations-content.md
- Plugins:
- FedRAMP validation: plugins/compliance-trestle-fedramp.md
- License: license.md
- Reference:
- Integrating with IBM SCC: reference/third-party-result-schema-SCC.md
- trestle API reference:
- cli: api_reference/trestle.cli.md
- common:
- common_types: api_reference/trestle.common.common_types.md
- const: api_reference/trestle.common.const.md
- err: api_reference/trestle.common.err.md
- file_utils: api_reference/trestle.common.file_utils.md
- list_utils: api_reference/trestle.common.list_utils.md
- load_validate: api_reference/trestle.common.load_validate.md
- log: api_reference/trestle.common.log.md
- model_utils: api_reference/trestle.common.model_utils.md
- str_utils: api_reference/trestle.common.str_utils.md
- trash: api_reference/trestle.common.trash.md
- type_utils: api_reference/trestle.common.type_utils.md
- core:
- all_validator: api_reference/trestle.core.all_validator.md
- base_model: api_reference/trestle.core.base_model.md
- catalog:
- catalog_api: api_reference/trestle.core.catalog.catalog_api.md
- catalog_interface: api_reference/trestle.core.catalog.catalog_interface.md
- catalog_merger: api_reference/trestle.core.catalog.catalog_merger.md
- catalog_reader: api_reference/trestle.core.catalog.catalog_reader.md
- catalog_writer: api_reference/trestle.core.catalog.catalog_writer.md
- catalog_validator: api_reference/trestle.core.catalog_validator.md
- commands:
- add: api_reference/trestle.core.commands.add.md
- assemble: api_reference/trestle.core.commands.assemble.md
- author:
- catalog: api_reference/trestle.core.commands.author.catalog.md
- command: api_reference/trestle.core.commands.author.command.md
- common: api_reference/trestle.core.commands.author.common.md
- component: api_reference/trestle.core.commands.author.component.md
- consts: api_reference/trestle.core.commands.author.consts.md
- docs: api_reference/trestle.core.commands.author.docs.md
- folders: api_reference/trestle.core.commands.author.folders.md
- headers: api_reference/trestle.core.commands.author.headers.md
- jinja: api_reference/trestle.core.commands.author.jinja.md
- prof: api_reference/trestle.core.commands.author.prof.md
- ssp: api_reference/trestle.core.commands.author.ssp.md
- versioning:
- template_versioning: api_reference/trestle.core.commands.author.versioning.template_versioning.md
- command_docs: api_reference/trestle.core.commands.command_docs.md
- common:
- cmd_utils: api_reference/trestle.core.commands.common.cmd_utils.md
- return_codes: api_reference/trestle.core.commands.common.return_codes.md
- create: api_reference/trestle.core.commands.create.md
- describe: api_reference/trestle.core.commands.describe.md
- href: api_reference/trestle.core.commands.href.md
- import_: api_reference/trestle.core.commands.import_.md
- init: api_reference/trestle.core.commands.init.md
- merge: api_reference/trestle.core.commands.merge.md
- partial_object_validate: api_reference/trestle.core.commands.partial_object_validate.md
- remove: api_reference/trestle.core.commands.remove.md
- replicate: api_reference/trestle.core.commands.replicate.md
- split: api_reference/trestle.core.commands.split.md
- task: api_reference/trestle.core.commands.task.md
- validate: api_reference/trestle.core.commands.validate.md
- version: api_reference/trestle.core.commands.version.md
- control_context: api_reference/trestle.core.control_context.md
- control_interface: api_reference/trestle.core.control_interface.md
- control_reader: api_reference/trestle.core.control_reader.md
- control_writer: api_reference/trestle.core.control_writer.md
- crm:
- bycomp_interface: api_reference/trestle.core.crm.bycomp_interface.md
- export_reader: api_reference/trestle.core.crm.export_reader.md
- export_writer: api_reference/trestle.core.crm.export_writer.md
- leveraged_statements: api_reference/trestle.core.crm.leveraged_statements.md
- ssp_inheritance_api: api_reference/trestle.core.crm.ssp_inheritance_api.md
- docs_control_writer: api_reference/trestle.core.docs_control_writer.md
- draw_io: api_reference/trestle.core.draw_io.md
- duplicates_validator: api_reference/trestle.core.duplicates_validator.md
- generators: api_reference/trestle.core.generators.md
- generic_oscal: api_reference/trestle.core.generic_oscal.md
- jinja: api_reference/trestle.core.jinja.md
- links_validator: api_reference/trestle.core.links_validator.md
- markdown:
- base_markdown_node: api_reference/trestle.core.markdown.base_markdown_node.md
- control_markdown_node: api_reference/trestle.core.markdown.control_markdown_node.md
- docs_markdown_node: api_reference/trestle.core.markdown.docs_markdown_node.md
- markdown_api: api_reference/trestle.core.markdown.markdown_api.md
- markdown_const: api_reference/trestle.core.markdown.markdown_const.md
- markdown_processor: api_reference/trestle.core.markdown.markdown_processor.md
- markdown_validator: api_reference/trestle.core.markdown.markdown_validator.md
- md_writer: api_reference/trestle.core.markdown.md_writer.md
- models:
- actions: api_reference/trestle.core.models.actions.md
- elements: api_reference/trestle.core.models.elements.md
- file_content_type: api_reference/trestle.core.models.file_content_type.md
- interfaces: api_reference/trestle.core.models.interfaces.md
- plans: api_reference/trestle.core.models.plans.md
- object_factory: api_reference/trestle.core.object_factory.md
- parser: api_reference/trestle.core.parser.md
- pipeline: api_reference/trestle.core.pipeline.md
- profile_resolver: api_reference/trestle.core.profile_resolver.md
- refs_validator: api_reference/trestle.core.refs_validator.md
- remote:
- cache: api_reference/trestle.core.remote.cache.md
- repository: api_reference/trestle.core.repository.md
- resolver:
- merge: api_reference/trestle.core.resolver.merge.md
- modify: api_reference/trestle.core.resolver.modify.md
- prune: api_reference/trestle.core.resolver.prune.md
- rule_parameters_validator: api_reference/trestle.core.rule_parameters_validator.md
- ssp_io: api_reference/trestle.core.ssp_io.md
- trestle_base_model: api_reference/trestle.core.trestle_base_model.md
- validator: api_reference/trestle.core.validator.md
- validator_factory: api_reference/trestle.core.validator_factory.md
- oscal:
- assessment_plan: api_reference/trestle.oscal.assessment_plan.md
- assessment_results: api_reference/trestle.oscal.assessment_results.md
- catalog: api_reference/trestle.oscal.catalog.md
- common: api_reference/trestle.oscal.common.md
- component: api_reference/trestle.oscal.component.md
- poam: api_reference/trestle.oscal.poam.md
- profile: api_reference/trestle.oscal.profile.md
- ssp: api_reference/trestle.oscal.ssp.md
- tasks:
- base_task: api_reference/trestle.tasks.base_task.md
- cis_xlsx_to_oscal_catalog: api_reference/trestle.tasks.cis_xlsx_to_oscal_catalog.md
- csv_to_oscal_cd: api_reference/trestle.tasks.csv_to_oscal_cd.md
- ocp4_cis_profile_to_oscal_catalog: api_reference/trestle.tasks.ocp4_cis_profile_to_oscal_catalog.md
- ocp4_cis_profile_to_oscal_cd: api_reference/trestle.tasks.ocp4_cis_profile_to_oscal_cd.md
- oscal_catalog_to_csv: api_reference/trestle.tasks.oscal_catalog_to_csv.md
- oscal_profile_to_osco_profile: api_reference/trestle.tasks.oscal_profile_to_osco_profile.md
- osco_result_to_oscal_ar: api_reference/trestle.tasks.osco_result_to_oscal_ar.md
- tanium_result_to_oscal_ar: api_reference/trestle.tasks.tanium_result_to_oscal_ar.md
- transform: api_reference/trestle.tasks.transform.md
- xccdf_result_to_oscal_ar: api_reference/trestle.tasks.xccdf_result_to_oscal_ar.md
- xlsx_helper: api_reference/trestle.tasks.xlsx_helper.md
- xlsx_to_oscal_cd: api_reference/trestle.tasks.xlsx_to_oscal_cd.md
- xlsx_to_oscal_profile: api_reference/trestle.tasks.xlsx_to_oscal_profile.md
- transforms:
- implementations:
- osco: api_reference/trestle.transforms.implementations.osco.md
- tanium: api_reference/trestle.transforms.implementations.tanium.md
- xccdf: api_reference/trestle.transforms.implementations.xccdf.md
- results: api_reference/trestle.transforms.results.md
- transformer_factory: api_reference/trestle.transforms.transformer_factory.md
- transformer_helper: api_reference/trestle.transforms.transformer_helper.md
- transformer_singleton: api_reference/trestle.transforms.transformer_singleton.md
plugins:
# warning don't use `macros`
- search
- autorefs
- htmlproofer:
enabled: true
validate_rendered_template: false
validate_external_urls: true
raise_error_after_finish: false
raise_error_excludes:
# This is to remove some false positives for links which work.
# Anchors are validated again by core mkdocs
404: ['#trestle.*']
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_inheritance_diagram: true
inherited_members: false
group_by_category: true
show_category_heading: true
show_if_no_docstring: true
show_root_heading: true
filters:
- '!^_[^_]'
- '!^__json'
- '!^__config__'
new_path_syntax: true
repo_name: oscal-compass/compliance-trestle
repo_url: https://github.com/oscal-compass/compliance-trestle
site_description: Documentation for compliance-trestle package.
site_name: Compliance Trestle
site_url: https://oscal-compass.github.io/compliance-trestle
theme:
features:
- content.code.annotate
- navigation.tabs
name: material
palette:
accent: purple
primary: teal
scheme: slate
validation:
omitted_files: warn
absolute_links: warn # Or 'relative_to_docs' - new in MkDocs 1.6
unrecognized_links: warn
anchors: warn # New in MkDocs 1.6