mkdocs.yml

# Project Information
site_name: PowerVCF
site_description: PowerShell Module for VMware Cloud Foundation
site_url: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation
site_author: Broadcom
docs_dir: docs
site_dir: .site
use_directory_urls: true

# Repository
repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation
edit_uri: blob/main/docs/

# Copyright
copyright: |
  Copyright &copy; 2005-2024 Broadcom. All Rights Reserved.<br/>
  The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.<br/><br/>

# Configuration
theme:
  name: material
  favicon: favicon.ico
  logo: assets/images/icon-white.svg
  icon:
    repo: fontawesome/brands/github
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: indigo
    toggle:
      icon: material/toggle-switch
      name: Dark Theme
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: indigo
    accent: indigo
    toggle:
      icon: material/toggle-switch-off-outline
      name: Light Theme
  font:
    text: Roboto
    code: Roboto Mono
  features:
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tabs.link
  - navigation.footer
  - navigation.header
  - navigation.indexes
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow

# Plugins
plugins:
- search:
    separator: '[\s\u200b\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- open-in-new-tab
- markdownextradata:
    jinja_options:
      variable_start_string: "${{"
      variable_end_string: "}}"
- git-revision-date-localized:
    enabled: !ENV [CI, false]
    enable_creation_date: false
    exclude:
      - index.md
    fallback_to_build_date: true
    type: timeago

# Customization
extra:
  config:
    repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation
    repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation
  version:
    default: latest
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation
    - icon: fontawesome/solid/book
      link: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
    - icon: fontawesome/solid/code
      link: https://developer.vmware.com/apis/vcf/
extra_css:
  - assets/stylesheets/extra.css

# Extensions
markdown_extensions:
- admonition
- attr_list
- footnotes
- md_in_html
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
    options:
      custom_icons:
      - material/.icons
- pymdownx.inlinehilite
- pymdownx.highlight:
    use_pygments: true
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.details
- tables
- toc:
    permalink: true

# Navigation
nav:
- Getting Started:
  - index.md
  - Installation: documentation/getting-started/install.md
  - Updating: documentation/getting-started/update.md
  - User Access: documentation/getting-started/user-access.md
  - Usage: documentation/getting-started/usage.md
  - Release Notes: release-notes.md
  - Release Milestones: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/milestones
  - License: license.md
- Reference:
  - documentation/index.md
  - Application Virtual Networks:
    - documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md
    - documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md
  - Authentication:
    - Cloud Builder:
      - documentation/functions/authentication/Connect-CloudBuilder.md
    - SDDC Manager:
      - documentation/functions/authentication/Request-VCFToken.md
  - Backup and Restore:
    - Backup:
        - documentation/functions/backup-restore/Get-VCFBackupConfiguration.md
        - documentation/functions/backup-restore/Set-VCFBackupConfiguration.md
        - documentation/functions/backup-restore/Start-VCFBackup.md
    - Restore:
        - documentation/functions/backup-restore/Get-VCFRestoreTask.md
        - documentation/functions/backup-restore/Start-VCFRestore.md
  - Bundles:
    - documentation/functions/bundles/Get-VCFBundle.md
    - documentation/functions/bundles/Request-VCFBundle.md
    - documentation/functions/bundles/Start-VCFBundleUpload.md
  - Customer Experience Improvement Program:
    - documentation/functions/ceip/Get-VCFCeip.md
    - documentation/functions/ceip/Set-VCFCeip.md
  - Certificates:
    - Certificate:
        - documentation/functions/certificates/Set-VCFCertificate.md
        - documentation/functions/certificates/Request-VCFCertificate.md
    - Certificate Authority:
        - documentation/functions/certificates/Get-VCFCertificateAuthority.md
        - documentation/functions/certificates/Remove-VCFCertificateAuthority.md
        - documentation/functions/certificates/Set-VCFMicrosoftCa.md
        - documentation/functions/certificates/Set-VCFOpensslCa.md
    - Certificate Signing Request:
        - documentation/functions/certificates/Get-VCFCertificate.md
        - documentation/functions/certificates/Get-VCFCertificateCsr.md
        - documentation/functions/certificates/Request-VCFCertificateCsr.md
  - Clusters:
    - documentation/functions/clusters/Get-VCFCluster.md
    - documentation/functions/clusters/Get-VCFClusterValidation.md
    - documentation/functions/clusters/New-VCFCluster.md
    - documentation/functions/clusters/Remove-VCFCluster.md
    - documentation/functions/clusters/Set-VCFCluster.md
  - Compliance:
    - documentation/functions/compliance/Get-VCFCompliance.md
    - documentation/functions/compliance/Get-VCFComplianceConfiguration.md
    - documentation/functions/compliance/Get-VCFComplianceHistory.md
    - documentation/functions/compliance/Get-VCFComplianceStandard.md
    - documentation/functions/compliance/Get-VCFComplianceTask.md
    - documentation/functions/compliance/New-VCFCompliance.md
  - Credentials:
    - documentation/functions/credentials/Get-VCFCredential.md
    - documentation/functions/credentials/Get-VCFCredentialExpiry.md
    - documentation/functions/credentials/Get-VCFCredentialTask.md
    - documentation/functions/credentials/Restart-VCFCredentialTask.md
    - documentation/functions/credentials/Set-VCFCredential.md
    - documentation/functions/credentials/Set-VCFCredentialAutoRotatePolicy.md
    - documentation/functions/credentials/Stop-VCFCredentialTask.md
  - Depots:
    - documentation/functions/depots/Get-VCFDepotCredential.md
    - documentation/functions/depots/Set-VCFDepotCredential.md
  - DNS and NTP:
    - DNS:
        - documentation/functions/dns-ntp/Get-VCFConfigurationDNS.md
        - documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md
        - documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md
    - NTP:
        - documentation/functions/dns-ntp/Get-VCFConfigurationNTP.md
        - documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md
        - documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md
  - Domains:
    - documentation/functions/domains/Get-VCFWorkloadDomain.md
    - documentation/functions/domains/New-VCFWorkloadDomain.md
    - documentation/functions/domains/Remove-VCFWorkloadDomain.md
    - documentation/functions/domains/Set-VCFWorkloadDomain.md
  - Hosts:
    - documentation/functions/hosts/Get-VCFHost.md
    - documentation/functions/hosts/New-VCFCommissionedHost.md
    - documentation/functions/hosts/Remove-VCFCommissionedHost.md
  - Identity and Access Management:
    - Users:
        - documentation/functions/iam/Get-VCFUser.md
        - documentation/functions/iam/New-VCFUser.md
        - documentation/functions/iam/Remove-VCFUser.md
        - documentation/functions/iam/New-VCFServiceUser.md
    - Groups:
        - documentation/functions/iam/New-VCFGroup.md
    - Roles:
      - documentation/functions/iam/Get-VCFRole.md
  - Identity Providers:
      - documentation/functions/idp/Get-VCFIdentityProvider.md
      - documentation/functions/idp/New-VCFIdentityProvider.md
      - documentation/functions/idp/Remove-VCFIdentityProvider.md
      - documentation/functions/idp/Update-VCFIdentityProvider.md
  - JSON Export:
      - documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md
  - Licenses:
    - documentation/functions/licenses/Get-VCFLicenseKey.md
    - documentation/functions/licenses/Get-VCFLicenseMode.md
    - documentation/functions/licenses/New-VCFLicenseKey.md
    - documentation/functions/licenses/Remove-VCFLicenseKey.md
  - Federation:
    - documentation/functions/federation/Get-VCFFederation.md
    - documentation/functions/federation/Get-VCFFederationMember.md
    - documentation/functions/federation/Get-VCFFederationTask.md
    - documentation/functions/federation/Join-VCFFederation.md
    - documentation/functions/federation/New-VCFFederationInvite.md
    - documentation/functions/federation/Remove-VCFFederation.md
    - documentation/functions/federation/Set-VCFFederation.md
  - FIPS:
    - documentation/functions/fips/Get-VCFFipsMode.md
  - Network Pools:
    - documentation/functions/network-pools/Add-VCFNetworkIPPool.md
    - documentation/functions/network-pools/Get-VCFNetworkIPPool.md
    - documentation/functions/network-pools/Get-VCFNetworkPool.md
    - documentation/functions/network-pools/New-VCFNetworkPool.md
    - documentation/functions/network-pools/Remove-VCFNetworkIPPool.md
    - documentation/functions/network-pools/Remove-VCFNetworkPool.md
  - NSX:
    - NSX Managers:
      - documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md
    - NSX Edge Clusters:
      - documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md
      - documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md
  - Personalities:
    - documentation/functions/personalities/Get-VCFPersonality.md
    - documentation/functions/personalities/New-VCFPersonality.md
  - Platform Services Controllers:
    - documentation/functions/pscs/Get-VCFPSC.md
  - Proxy:
    - documentation/functions/proxy/Get-VCFProxy.md
    - documentation/functions/proxy/Set-VCFProxy.md
  - Releases:
    - documentation/functions/releases/Get-VCFRelease.md
  - SDDC (Cloud Builder):
    - documentation/functions/sddc/Get-CloudBuilderSDDC.md
    - documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md
    - documentation/functions/sddc/Restart-CloudBuilderSDDC.md
    - documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md
    - documentation/functions/sddc/Start-CloudBuilderSDDC.md
    - documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md
    - documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md
  - SDDC Manager:
    - documentation/functions/sddc-managers/Get-VCFManager.md
  - Services:
    - documentation/functions/services/Get-VCFService.md
  - Supportability and Serviceability (SoS):
    - Health Summary:
      - documentation/functions/sos/Get-VCFHealthSummaryTask.md
      - documentation/functions/sos/Request-VCFHealthSummaryBundle.md
      - documentation/functions/sos/Start-VCFHealthSummary.md
    - Support Bundles:
      - documentation/functions/sos/Get-VCFSupportBundleTask.md
      - documentation/functions/sos/Request-VCFSupportBundle.md
      - documentation/functions/sos/Start-VCFSupportBundle.md
  - System Prechecks:
    - documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md
    - documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md
  - Tasks:
    - documentation/functions/tasks/Get-VCFTask.md
    - documentation/functions/tasks/Restart-VCFTask.md
  - Upgrades:
    - documentation/functions/upgrades/Get-VCFUpgradable.md
    - documentation/functions/upgrades/Get-VCFUpgrade.md
    - documentation/functions/upgrades/Start-VCFUpgrade.md
  - vCenter Server:
    - documentation/functions/vcenters/Get-VCFvCenter.md
  - Aria Suite Lifecycle:
    - documentation/functions/aria-suite/aria-suite-lifecycle/Get-VCFVrslcm.md
    - documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md
    - documentation/functions/aria-suite/aria-suite-lifecycle/Remove-VCFVrslcm.md
    - documentation/functions/aria-suite/aria-suite-lifecycle/Reset-VCFVrslcm.md
  - Aria Automation:
    - documentation/functions/aria-suite/aria-automation/Get-VCFVra.md
  - Aria Operations:
    - documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md
    - documentation/functions/aria-suite/aria-operations/Get-VCFVropsConnection.md
    - documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md
  - Aria Operations for Logs:
    - documentation/functions/aria-suite/aria-operations-logs/Get-VCFVrli.md
    - documentation/functions/aria-suite/aria-operations-logs/Get-VCFVrliConnection.md
    - documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md
  - Workspace ONE Access:
    - documentation/functions/aria-suite/workspace-one-access/Get-VCFWsa.md
  - Other:
    - documentation/functions/other/Invoke-VCFCommand.md
- Community:
  - community/index.md
  - Contributing: community/contributing.md
  - Discussions: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/discussions
  - Search Issues: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/issues
  - Open an Issue: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/issues/new/choose
  - Support: community/support.md
  - Code of Conduct: community/code-of-conduct.md