otterdog/mkdocs.yml at main · eclipse-csi/otterdog · 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
site_name: otterdog
site_description: Manage GitHub organizations at scale
strict: true
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "http://localhost:8000/"]

theme:
  name: 'material'
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: indigo
    toggle:
      icon: material/lightbulb-outline
      name: "Switch to dark mode"
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: indigo
    accent: indigo
    toggle:
      icon: material/lightbulb
      name: "Switch to light mode"
  features:
    - content.tabs.link
    - content.code.annotate
    - announce.dismiss
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.expand
    - toc.integrate
  logo: 'otterdog.png'
  favicon: 'favicon.png'

repo_url: https://github.com/eclipse-csi/otterdog
edit_uri: edit/main/docs/

nav:
- Get Started:
    - Overview: index.md
- Reference:
    - reference/index.md
    - Resources:
      - Format: reference/resource-format.md
      - GitHub Organization:
        - reference/organization/index.md
        - Organization Settings: reference/organization/settings.md
        - Organization Role: reference/organization/role.md
        - Organization Webhook: reference/organization/webhook.md
        - Organization Secret: reference/organization/secret.md
        - Organization Variable: reference/organization/variable.md
        - Organization Ruleset: reference/organization/ruleset.md
        - Custom Property: reference/organization/custom-property.md
        - Team: reference/organization/team.md
        - Repository:
          - reference/organization/repository/index.md
          - Repository Webhook: reference/organization/repository/webhook.md
          - Repository Secret: reference/organization/repository/secret.md
          - Repository Variable: reference/organization/repository/variable.md
          - Environment:
            - reference/organization/repository/index.md
            - Environment Secret: reference/organization/repository/environment/secret.md
            - Environment Variable: reference/organization/repository/environment/variable.md
          - Branch Protection Rule: reference/organization/repository/branch-protection-rule.md
          - Repository Ruleset: reference/organization/repository/ruleset.md
        - Referenced Types:
           - Actor: reference/organization/repository/actor.md
           - Branch or Tag: reference/organization/repository/branch-or-tag.md
           - Bypass Actor: reference/organization/repository/bypass-actor.md
           - Repo Name Matcher: reference/organization/repo-name-matcher.md
           - Ref Matcher: reference/organization/repository/ref-matcher.md
           - Status Check: reference/organization/repository/status-check.md
    - Policies:
        - reference/policies/index.md
        - Upload SBOM data to dependency track: reference/policies/dependency-track-upload.md
        - Usage of macOS large runners: reference/policies/macos-large-runners.md
    - Blueprints:
        - reference/blueprints/index.md
        - Required File: reference/blueprints/required-file.md
        - Pin Workflow: reference/blueprints/pin-workflow.md
        - Append Configuration: reference/blueprints/append-configuration.md
        - OSSF Scorecard Integration: reference/blueprints/scorecard-integration.md

    - CLI Operations:
        - reference/operations/index.md
        - Apply: reference/operations/apply.md
        - Import: reference/operations/import.md
        - Plan: reference/operations/plan.md
        - Validate: reference/operations/validate.md
        - List Advisories: reference/operations/list-advisories.md
- User Guide:
    - userguide/index.md
    - Workflow: userguide/workflow.md
    - Adding new Resources: userguide/adding.md
    - Renaming of Resources: userguide/renaming.md
    - Removal of Resources: userguide/removal.md
    - Unsupported Settings: userguide/unsupported.md

- Operating Otterdog:
    - operating_otterdog/index.md
    - operating_otterdog/install.md
    - operating_otterdog/setup.md
    - operating_otterdog/usage.md

- Developing Otterdog:
    - Overview: developing_otterdog/index.md
    - Development Setup: developing_otterdog/development_setup.md
    - Architecture: developing_otterdog/architecture.md
    - Contribution Workflow: developing_otterdog/contribution_workflow.md
    - Coding & Style Guidelines: developing_otterdog/coding_style.md
    - Testing: developing_otterdog/testing.md
    - Release Process: developing_otterdog/release_process.md

markdown_extensions:
- admonition
- tables
- toc:
    permalink: true
    title: Page
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
# extra must be loaded before superfences
- pymdownx.extra
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
    alternate_style: true

watch: []

plugins:
- include-markdown
- search
- exclude:
    glob:
    - __pycache__/*