docs/base.yml at master · concourse/docs · GitHub

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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
site_name: Concourse
site_url: https://concourse-ci.org/

repo_url: https://github.com/concourse/concourse
repo_name: concourse/concourse

edit_uri: https://github.com/concourse/docs/blob/master/docs/

watch:
  - docs
  - overrides

markdown_extensions:
  - admonition
  - def_list
  - tables
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - pymdownx.blocks.caption
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - "." # Current directory
        - "docs" # docs directory
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

extra_css:
  - assets/stylesheets/mwc-theme.css

extra_javascript:
  - assets/javascripts/mwc-bundle.min.js

exclude_docs: |
  libs/**/*.md
  libs/examples/apps
  libs/examples/terraform
  libs/examples/misc
  libs/examples/LICENSE

theme:
  name: material
  custom_dir: overrides
  font:
    text: Roboto Slab
  features:
    - navigation.tabs # Top-level tabs
    - navigation.tabs.sticky # Keep tabs visible
    - navigation.indexes # Section index pages
    - navigation.instant # SPA-like navigation
    - navigation.top # Back to top button
    - navigation.footer # Previous/next links
    - content.action.edit # Edit Page in GitHub
    - content.action.view # View raw Page in GitHub
    - content.code.copy # Copy code
    - attr_list # Attribute Lists
    - md_in_html # Markdown in HTML
    - pymdownx.blocks.caption # Caption

  palette:
    - scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  logo: assets/logo-white.svg
  favicon: assets/favicon.ico

copyright: >-
  Copyright &copy; 2026 The Linux Foundation &reg; –
  <a href="#__consent">Change cookie settings</a>

extra:
  analytics:
    provider: goattracker
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits. With your consent, you're helping us to
      make our documentation better.
    cookies:
      analytics:
        name: Goat Tracker Analytics
        checked: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/concourse
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/concourse
    - icon: fontawesome/brands/discord
      link: https://discord.gg/MeRxXKW
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/concourse-ci.org
    - icon: fontawesome/solid/paper-plane
      link: mailto:contact@concourse-ci.org

not_in_nav: |
  index.md

nav:
  - Docs:
      - docs/index.md
      - Getting Started:
          - docs/getting-started/index.md
          - docs/getting-started/quick-start.md
          - docs/getting-started/hello-world.md
          - docs/getting-started/inputs-outputs.md
          - docs/getting-started/resources.md
      - Install:
          - docs/install/index.md
          - docs/install/running-postgres.md
          - docs/install/concourse-cli.md
          - docs/install/generating-keys.md
          - docs/install/running-web.md
          - docs/install/running-worker.md
          - docs/install/upgrading-concourse.md
      - Auth & Teams:
          - docs/auth-and-teams/index.md
          - docs/auth-and-teams/main-team.md
          - Configuring Auth:
              - docs/auth-and-teams/configuring/index.md
              - docs/auth-and-teams/configuring/local-user.md
              - docs/auth-and-teams/configuring/github.md
              - docs/auth-and-teams/configuring/gitlab.md
              - docs/auth-and-teams/configuring/bitbucket-cloud.md
              - docs/auth-and-teams/configuring/cf-uaa.md
              - docs/auth-and-teams/configuring/ldap.md
              - docs/auth-and-teams/configuring/microsoft.md
              - docs/auth-and-teams/configuring/generic-oidc.md
              - docs/auth-and-teams/configuring/generic-oauth.md
              - docs/auth-and-teams/configuring/generic-saml.md
          - docs/auth-and-teams/managing-teams.md
          - docs/auth-and-teams/user-roles.md
          - docs/auth-and-teams/exposing.md
          - docs/auth-and-teams/caveats.md
      - docs/fly.md
      - docs/config-basics.md
      - Pipelines:
          - docs/pipelines/index.md
          - docs/pipelines/setting-pipelines.md
          - docs/pipelines/managing-pipelines.md
          - docs/pipelines/grouping-pipelines.md
      - docs/vars.md
      - Resources:
          - docs/resources/index.md
          - docs/resources/resource-versions.md
          - docs/resources/managing-resources.md
      - Resource Types:
          - docs/resource-types/index.md
          - docs/resource-types/implementing.md
          - docs/resource-types/managing-types.md
      - docs/jobs.md
      - Steps:
          - docs/steps/index.md
          - docs/steps/get.md
          - docs/steps/put.md
          - docs/steps/task.md
          - docs/steps/set-pipeline.md
          - docs/steps/load-var.md
          - docs/steps/in-parallel.md
          - docs/steps/do.md
          - docs/steps/try.md
          - Modifiers and Hooks:
              - docs/steps/modifier-and-hooks/index.md
              - docs/steps/modifier-and-hooks/across.md
              - docs/steps/modifier-and-hooks/timeout.md
              - docs/steps/modifier-and-hooks/attempts.md
              - docs/steps/modifier-and-hooks/tags.md
              - docs/steps/modifier-and-hooks/on-success.md
              - docs/steps/modifier-and-hooks/on-failure.md
              - docs/steps/modifier-and-hooks/on-abort.md
              - docs/steps/modifier-and-hooks/on-error.md
              - docs/steps/modifier-and-hooks/ensure.md
      - docs/tasks.md
      - docs/builds.md
      - How-To Guides:
          - docs/how-to/index.md
          - Pipeline Guides:
              - docs/how-to/pipeline-guides/index.md
              - docs/how-to/pipeline-guides/managing-pipeline-configs.md
              - docs/how-to/pipeline-guides/common-pipeline.md
              - docs/how-to/pipeline-guides/task-inputs-outputs.md
              - docs/how-to/pipeline-guides/gated-pipelines.md
              - docs/how-to/pipeline-guides/time-triggered-pipelines.md
              - docs/how-to/pipeline-guides/manual-approval.md
          - Git Guides:
              - docs/how-to/git-guides/index.md
              - docs/how-to/git-guides/basic.md
              - docs/how-to/git-guides/multi-branch.md
          - Container Image Guides:
              - docs/how-to/container-image-guides/index.md
              - docs/how-to/container-image-guides/build-push.md
              - docs/how-to/container-image-guides/build-use.md
      - Operation:
          - docs/operation/index.md
          - docs/operation/metrics.md
          - docs/operation/tracing.md
          - docs/operation/encryption.md
          - Credential Management:
              - docs/operation/creds/index.md
              - docs/operation/creds/vault.md
              - docs/operation/creds/credhub.md
              - docs/operation/creds/aws-ssm.md
              - docs/operation/creds/aws-secrets.md
              - docs/operation/creds/kubernetes.md
              - docs/operation/creds/conjur.md
              - docs/operation/creds/id-token.md
              - docs/operation/creds/caching.md
              - docs/operation/creds/redacting.md
              - docs/operation/creds/retrying-failed.md
          - docs/operation/security-hardening.md
          - docs/operation/container-placement.md
          - docs/operation/opa-integration.md
          - docs/operation/tuning.md
          - docs/operation/global-resources.md
          - docs/operation/administration.md
      - docs/observation.md
      - Internals:
          - docs/internals/index.md
          - docs/internals/checker.md
          - docs/internals/scheduler.md
          - docs/internals/build-tracker.md
          - docs/internals/garbage-collector.md
  - Examples:
      - examples/index.md
      - examples/hello-world.md
      - examples/serial-job.md
      - examples/pipeline-vars.md
      - examples/set-pipeline.md
      - examples/inputs-outputs.md
      - examples/time-triggered.md
      - examples/git-triggered.md
      - examples/manually-triggered.md
      - examples/job-and-task-hooks.md
      - examples/golang-lib.md
      - examples/rails-app.md
      - examples/java-app.md
      - examples/nodejs-app.md
      - examples/php-app.md
  - project/index.md
  - ecosystem/index.md
  - support/index.md
  - Resource Types: resource-types-list.md
  - Blog:
      - blog/index.md