forked from boozallen/jenkins-templating-engine
-
Notifications
You must be signed in to change notification settings - Fork 58
/
mkdocs.yml
185 lines (178 loc) · 6.8 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
site_name: Jenkins Templating Engine
theme:
name: material
palette:
primary: teal
features:
- navigation.instant
- navigation.tabs
- navigation.sections
- navigation.indexes
- navigation.top
- content.code.annotate
repo_url: https://github.com/jenkinsci/templating-engine-plugin
edit_uri: edit/main/docs/
plugins:
- search: {}
- gen-files:
scripts:
- 'docs/add_glossary.py'
extra_css:
- css/extra.css
extra:
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/jenkinsci/templating-engine-plugin
- icon: fontawesome/brands/gitter
link: https://gitter.im/jenkinsci/templating-engine-plugin
version:
provider: mike
default: latest
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_ID
markdown_extensions:
- admonition
- abbr
- footnotes
- attr_list
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: true
- pymdownx.snippets:
base_path: "docs"
- pymdownx.betterem:
smart_enable: all
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.details
# Page Tree
nav:
- Home: 'index.md'
- Concepts:
- Framework Overview:
- 'concepts/framework-overview/index.md'
- 'concepts/framework-overview/bottom-up.md'
- 'concepts/framework-overview/top-down.md'
- 'concepts/framework-overview/key-benefits.md'
- Pipeline Templates:
- 'concepts/pipeline-templates/index.md'
- 'concepts/pipeline-templates/pipeline-catalog.md'
- 'concepts/pipeline-templates/declarative-syntax.md'
- Pipeline Configuration:
- 'concepts/pipeline-configuration/index.md'
- 'concepts/pipeline-configuration/configuration-dsl.md'
- 'concepts/pipeline-configuration/merging-configs.md'
- Pipeline Primitives:
- 'concepts/pipeline-primitives/index.md'
- 'concepts/pipeline-primitives/steps.md'
- 'concepts/pipeline-primitives/stages.md'
- 'concepts/pipeline-primitives/application-environments.md'
- 'concepts/pipeline-primitives/keywords.md'
- 'concepts/pipeline-primitives/primitive-namespace.md'
- Library Development:
- 'concepts/library-development/index.md'
- 'concepts/library-development/library-structure.md'
- 'concepts/library-development/library-steps.md'
- 'concepts/library-development/library-resources.md'
- 'concepts/library-development/library-classes.md'
- 'concepts/library-development/parameterizing-libraries.md'
- 'concepts/library-development/library-configuration-file.md'
- 'concepts/library-development/library-source.md'
- 'concepts/library-development/lifecycle-hooks.md'
- 'concepts/library-development/multi-method-steps.md'
- 'concepts/library-development/step-aliasing.md'
- Pipeline Governance:
- 'concepts/pipeline-governance/index.md'
- 'concepts/pipeline-governance/configuration-hierarchy.md'
- 'concepts/pipeline-governance/governance-tier.md'
- 'concepts/pipeline-governance/pipeline-template-selection.md'
- 'concepts/pipeline-governance/library-resolution.md'
- Advanced Topics:
- 'concepts/advanced/pipeline-initialization.md'
- 'concepts/advanced/overloading-steps.md'
- Reference:
- 'reference/overview.md'
- 'reference/pipeline-configuration-schema.md'
- 'reference/autowired-variables.md'
- 'reference/library-configuration-schema.md'
- 'reference/governance-tier.md'
- Tutorials:
- 'tutorials/index.md'
- Learning Lab - Local Development:
- tutorials/local-development/index.md
- tutorials/local-development/1-prerequisites.md
- tutorials/local-development/2-run-jenkins.md
- tutorials/local-development/3-configure-jenkins.md
- tutorials/local-development/4-validate-jenkins.md
- Learning Lab - The Basics:
- tutorials/jte-the-basics/index.md
- tutorials/jte-the-basics/1-prerequisites.md
- tutorials/jte-the-basics/2-pipeline-job.md
- tutorials/jte-the-basics/3-first-libraries.md
- tutorials/jte-the-basics/4-first-configuration-file.md
- tutorials/jte-the-basics/5-swap-to-gradle.md
- tutorials/jte-the-basics/6-multibranch.md
- tutorials/jte-the-basics/7-github-org.md
- tutorials/jte-the-basics/8-summary.md
- Learning Lab - Pipeline Primitives:
- tutorials/jte-primitives/index.md
- tutorials/jte-primitives/1-prerequisites.md
- tutorials/jte-primitives/2-pipeline-job.md
- tutorials/jte-primitives/3-stages.md
- tutorials/jte-primitives/4-application-environments.md
- tutorials/jte-primitives/5-keywords.md
- tutorials/jte-primitives/6-summary.md
- Learning Lab - Advanced Features:
- tutorials/jte-advanced-features/index.md
- tutorials/jte-advanced-features/1-prerequisites.md
- tutorials/jte-advanced-features/2-default-step-implementation.md
- tutorials/jte-advanced-features/3-pipeline-lifecycle-hooks.md
- tutorials/jte-advanced-features/4-multimethod-steps.md
- tutorials/jte-advanced-features/5-summary.md
- How-To Guides:
- 'how-to/overview.md'
- Library Development:
- 'how-to/library-development/lifecycle-hooks-on-failure.md'
- 'how-to/library-development/package-libraries-as-plugin.md'
- Upgrade Guides:
- 'how-to/upgrade-2.0/index.md'
- Contributing:
- 'contributing/fork-based.md'
- ⚙️ Actions:
- 'contributing/linting.md'
- 'contributing/running-tests.md'
- 'contributing/building.md'
- 'contributing/releasing.md'
- 📓 Documentation:
- 'contributing/docs/getting-started.md'
- 'contributing/docs/documentation-structure.md'
- 'contributing/docs/local-development.md'
- 'contributing/docs/markdown-lint.md'
- 'contributing/docs/vale.md'
- 'contributing/docs/add-or-remove-pages.md'
- 'contributing/docs/acronyms.md'
- 'contributing/docs/markdown-cheatsheet.md'
- Developer Docs:
- 'developer/index.md'
- Pipeline Initialization:
- 'developer/pipeline-initialization/index.md'
- 'developer/pipeline-initialization/aggregate-configs.md'
- 'developer/pipeline-initialization/determine-template.md'
- 'developer/pipeline-initialization/inject-primitives.md'
- Jenkins Configurations:
- 'developer/jenkins-config/index.md'
- 'developer/jenkins-config/job-types.md'
- 'developer/jenkins-config/governance-tiers.md'
- Testing:
- 'developer/testing/index.md'
- 'developer/testing/local-jenkins.md'