build-tools-for-vmware-aria/mkdocs.yml at main · vmware/build-tools-for-vmware-aria · 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
site_name: Build Tools for Aria Docs
repo_url: https://github.com/vmware/build-tools-for-vmware-aria
docs_dir: mkdocs
# Fail if can not resolve links
strict: true
theme:
  name: material
  logo: assets/logo.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.indexes
    - toc.follow
    - search.highlight
    - search.suggest
    - search.share
    - content.code.annotate
    - content.code.copy
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-night
        name: Dark Mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Light Mode
extra:
  version:
    provider: mike
  iac:
    latest_release: 4.22.0
  general:
    bta_name: Build Tools for VMware Aria
    installer_bundle_profile: bundle-with-installer
  products:
    vro_short_name: Orchestrator
    vro_7_full_name: vRealize Orchestrator
    vro_7_short_name: vRO
    vro_8_full_name: Aria Automation Orchestrator
    vro_9_full_name: VCF Operations Orchestrator
    vra_8_full_name: Aria Automation
    vra_8_short_name: vRA 8
    vra_cloud_short_name: vRA Cloud
    vra_9_classic_full_name: VCF Automation VM Apps Organization
    vra_9_all_apps_full_name: VCF Automation All Apps Organization
    vra_9_full_name: VCF Automation
    vra_9_short_name: VCFA
    vrops_8_full_name: Aria Operations
    vrops_9_full_name: VCF Operations
    vrops_9_short_name: VCF Ops
    vrli_8_full_name: Aria Operations for Logs
    vrli_9_full_name: VCF Operations for Logs
  archetype:
    customer_project:
      group_id: com.company.bu
      group_id_hint: The `groupId` in Maven is a distinct identifier that is used as a base name of the company or group that creates the project. It acts as a namespace that ensures that project names don't clash with each other. It is recommended to choose a `groupId` that reflects your organization or main project.
      artifact_id: project.type
      artifact_id_hint: The `artifactId` is a unique identifier for a specific project or module within a company or group project. It represents the name of the artifact that is generated by the project. It is recommended to choose an `artifactId` that reflects the specific project (and project type).
      maven_settings_location_hint: The location of the `settings.xml` file for **MacOS** is `~/.m2` and `C:\Users\username\\.m2` for **Windows**.
      maven_profile_name: target-env
      archetype_version_hint: This parameter is optional. The default value is 2.38.1. Note that archetype contents may change so it is recommended to use an up-to-date version.


plugins:
  - include-markdown
  - search
  - awesome-pages
  - tags
  - macros:
      on_error_fail: true
  - mike:
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
# extra_css:
#   - css/version-select.css
# extra_javascript:
#   - js/version-select.js