opct/mkdocs.yml at main · redhat-openshift-ecosystem/opct · 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
site_name: OPCT
site_description: OpenShift Provider Compatibility Tool
site_url: https://redhat-openshift-ecosystem.github.io/opct
repo_url: https://github.com/redhat-openshift-ecosystem/opct
edit_uri: edit/main/docs/
docs_dir: ./docs
dev_addr: 127.0.0.1:8000

# ###############
# Page Navigation
#

nav:
  #
  # Welcome
  # This section documents summary of the project, Quick start, FAQ, etc
  #
  - Introduction: README.md
  - Welcome:
    - Getting Started: getting-started.md

  #
  # User Guides
  #
  - Validation User Guide:
    - guides/cluster-validation/index.md
    - Installation Checklist: guides/cluster-validation/installation-checklist.md
    - Installation Review: guides/cluster-validation/installation-review.md
    - Disconnected Installations: guides/cluster-validation/installation-disconnected.md

  #
  # Review Guides
  #
  - Review Guides:
    - review/index.md
    - OPCT Rules: review/rules.md
    - Support Guide: guides/support-guide.md
    - Troubleshooting: review/troubleshooting.md
    - "Reviewing results with AI Assistant": review/review-assistant.md

  #
  # CLI Reference
  #
  - CLI Reference:
    #- Getting started: getting-started.md
    - opct:
      - opct/index.md
      - get images: opct/get.md
      - run: opct/run.md
      - retrieve: opct/retrieve.md
      - report: opct/report.md
      - results: opct/results.md
      - status: opct/status.md
      - destroy: opct/destroy.md
      - adm:
        - adm: opct/adm/index.md
        - e2e-dedicated taint-node: opct/adm/e2e-dedicated-taint-node.md
        - generate: opct/adm/generate.md
        - generate checks-docs: opct/adm/generate-checks-docs.md
        - parse-etcd-logs: opct/adm/parse-etcd-logs.md
        - parse-metrics: opct/adm/parse-metrics.md
        - parse-junit: opct/adm/parse-junit.md
        - cleaner: opct/adm/cleaner.md
        - baseline: opct/adm/baseline.md
      - version: opct/version.md

  #
  # References
  #
  - Overview:
    - FAQ Tool: FAQ.md
    - FAQ Contributing: devel/FAQ.md
  #
  # Contributing
  #
  - Contributing:
    - Release Guide: devel/release.md
    - Update Guide: devel/update.md
    - Quick Start: devel/CONTRIBUTING.md
    - Development Guide: devel/guide.md
    #- Workflow: devel/contribution-workflow.md
    - OPCT Documentation (this site): devel/docs.md
    - Architecture/Diagrams:
      - diagrams/index.md
      - diagrams/opct-sequence.md
      - "Reference Architecture": diagrams/ocp-architecture-reference.md
    - BYO Plugin: devel/byo-plugin.md
    #- Repositories: devel/repositories.md
    - Architectures: devel/arch-support.md
    - "Devel Guide: Creating cluster with platform type External": devel/create-cluster-external.md
  - Release Notes:
    # TODO: Create release note file document with summary updates by release.
    - CHANGELOG.md

# ##########
# Page setup
#
markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      check_paths: true

plugins:
  - diagrams:
      file_extension: ".diagram.py"
      max_workers: 5
  - search

theme:
  name: material
  highlightjs: true
  hljs_languages:
    - yaml
  features:
    #- toc.integrate
    # add button to return to top
    - navigation.top
    # use sections
    - navigation.sections
    # expand subsections by default
    - navigation.expand
    # show path of page on top
    - navigation.path