Skip to content

Commit

Permalink
docs: documentation updates (#467)
Browse files Browse the repository at this point in the history
- Updates installation documentation for the next release.
- Updates the MkDocs plugin requirements.
- Updates the MkDocs configuration to include missing functions.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
  • Loading branch information
tenthirtyam authored Jan 12, 2024
1 parent 9f05c89 commit 157c75d
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
7 changes: 3 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
mkdocs-git-authors-plugin>=0.7.2
mkdocs-git-revision-date-localized-plugin>=1.2.0
mkdocs-git-revision-date-localized-plugin>=1.2.2
mkdocs-markdownextradata-plugin>=0.2.5
mkdocs-minify-plugin>=0.7.1
mkdocs-open-in-new-tab>=1.0.2
mkdocs-minify-plugin>=0.7.2
mkdocs-open-in-new-tab>=1.0.3
2 changes: 1 addition & 1 deletion docs/snippets/install-module.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Install-Module -Name VMware.PowerCLI -MinimumVersion 13.1.0 -Repository PSGaller
Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Repository PSGallery
Install-Module -Name PowerVCF -MinimumVersion 2.4.0 -Repository PSGallery
Install-Module -Name ImportExcel -MinimumVersion 7.8.5 -Repository PSGallery
Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.7.0 -Repository PSGallery
Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.8.0 -Repository PSGallery
14 changes: 13 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ plugins:
jinja_options:
variable_start_string: "${{"
variable_end_string: "}}"
- git-authors
- git-revision-date-localized:
enabled: !ENV [CI, false]
enable_creation_date: false
Expand Down Expand Up @@ -145,6 +144,7 @@ nav:
- documentation/functions/aria-suite/aria-automation/Export-vRAJsonSpec.md
- documentation/functions/aria-suite/aria-automation/Get-CloudProxy.md
- documentation/functions/aria-suite/aria-automation/Get-CloudProxyOtk.md
- documentation/functions/aria-suite/aria-automation/Get-vRAAPIVersion.md
- documentation/functions/aria-suite/aria-automation/Get-vRACloudAccount.md
- documentation/functions/aria-suite/aria-automation/Get-vRACloudZone.md
- documentation/functions/aria-suite/aria-automation/Get-vRAGroup.md
Expand Down Expand Up @@ -175,6 +175,7 @@ nav:
- documentation/functions/aria-suite/aria-automation/Remove-vRAUserOrgRole.md
- documentation/functions/aria-suite/aria-automation/Remove-vRAUserServiceRole.md
- documentation/functions/aria-suite/aria-automation/Remove-vRAvRLIConfig.md
- documentation/functions/aria-suite/aria-automation/Request-vRAToken.md
- documentation/functions/aria-suite/aria-automation/Set-vRADnsConfig.md
- documentation/functions/aria-suite/aria-automation/Set-vRAGroupOrgRole.md
- documentation/functions/aria-suite/aria-automation/Set-vRAGroupServiceRole.md
Expand Down Expand Up @@ -409,12 +410,14 @@ nav:
- documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMLockerPassword.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMMyVmwareAccount.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMProductNtpServer.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMRequest.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Request-vRSLCMProductBinary.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Request-vRSLCMToken.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Resume-vRSLCMRequest.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Set-vRSLCMApplianceNtpConfig.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Set-vRSLCMDnsConfig.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Start-vRSLCMProductNode.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Stop-vRSLCMProductNode.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Test-vRSLCMAuthentication.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Test-vRSLCMConnection.md
- documentation/functions/aria-suite/aria-suite-lifecycle/Undo-vRSLCMDatacenter.md
Expand Down Expand Up @@ -446,6 +449,7 @@ nav:
- documentation/functions/nsx/Get-NsxtBackupHistory.md
- documentation/functions/nsx/Get-NsxtCertificate.md
- documentation/functions/nsx/Get-NsxtComputeManager.md
- documentation/functions/nsx/Get-NsxtComputeManagerStatus.md
- documentation/functions/nsx/Get-NsxtEdgeCluster.md
- documentation/functions/nsx/Get-NsxtEdgeNode.md
- documentation/functions/nsx/Get-NsxtEdgeNodeAuthPolicy.md
Expand Down Expand Up @@ -510,6 +514,7 @@ nav:
- documentation/functions/nsx/Remove-NsxtSecurityPolicy.md
- documentation/functions/nsx/Remove-NsxtSegment.md
- documentation/functions/nsx/Remove-NsxtSyslogExporter.md
- documentation/functions/nsx/Request-NsxtToken.md
- documentation/functions/nsx/Set-NsxtApplianceUserExpirationPolicy.md
- documentation/functions/nsx/Set-NsxtApplianceUserPassword.md
- documentation/functions/nsx/Set-NsxtCertificate.md
Expand All @@ -529,6 +534,7 @@ nav:
- documentation/functions/nsx/Undo-NsxtIdentitySource.md
- documentation/functions/nsx/Undo-NsxtLdapRole.md
- documentation/functions/nsx/Undo-NsxtNodeProfileSyslogExporter.md
- documentation/functions/nsx/Undo-RouteMap.md
- documentation/functions/nsx/Undo-NsxtVidmRole.md
- documentation/functions/nsx/Undo-PrefixList.md
- SDDC Manager:
Expand Down Expand Up @@ -610,6 +616,7 @@ nav:
- documentation/functions/vsphere/Get-VMOvfProperty.md
- documentation/functions/vsphere/Get-VMvAppConfig.md
- documentation/functions/vsphere/Get-VsanHealthTest.md
- documentation/functions/vsphere/Install-VamiCertificate.md
- documentation/functions/vsphere/Invoke-VcenterCommand.md
- documentation/functions/vsphere/Move-VMtoFolder.md
- documentation/functions/vsphere/New-VcLicense.md
Expand Down Expand Up @@ -669,6 +676,7 @@ nav:
- documentation/functions/vsphere-replication/Get-VrmsTask.md
- documentation/functions/vsphere-replication/Get-VrmsVamiCertificate.md
- documentation/functions/vsphere-replication/Install-vSphereReplicationManager.md
- documentation/functions/vsphere-replication/Remove-VrmsConfiguration.md
- documentation/functions/vsphere-replication/Request-VrmsToken.md
- documentation/functions/vsphere-replication/Set-VrmsApplianceState.md
- documentation/functions/vsphere-replication/Set-VrmsConfiguration.md
Expand Down Expand Up @@ -698,6 +706,7 @@ nav:
- documentation/functions/vsphere-tanzu/Get-TanzuKubernetesCluster.md
- documentation/functions/vsphere-tanzu/Get-SubscribedLibrary.md
- documentation/functions/vsphere-tanzu/Get-VMClass.md
- documentation/functions/vsphere-tanzu/Get-WMLicenseStatus.md
- documentation/functions/vsphere-tanzu/Get-WMRegistry.md
- documentation/functions/vsphere-tanzu/Get-WMRegistryHealth.md
- documentation/functions/vsphere-tanzu/Install-SupervisorClusterCertificate.md
Expand All @@ -707,6 +716,8 @@ nav:
- documentation/functions/vsphere-tanzu/Remove-WMRegistry.md
- documentation/functions/vsphere-tanzu/Request-WMClusterCSR.md
- documentation/functions/vsphere-tanzu/Test-WMSubnetInput.md
- documentation/functions/vsphere-tanzu/Undo-Namespace.md
- documentation/functions/vsphere-tanzu/Undo-NamespacePermission.md
- documentation/functions/vsphere-tanzu/Undo-Registry.md
- documentation/functions/vsphere-tanzu/Undo-SupervisorCluster.md
- documentation/functions/vsphere-tanzu/Undo-TanzuKubernetesCluster.md
Expand Down Expand Up @@ -740,6 +751,7 @@ nav:
- documentation/functions/workspace-one-access/Get-WSAUser.md
- documentation/functions/workspace-one-access/Initialize-WorkspaceOne.md
- documentation/functions/workspace-one-access/Install-WorkspaceOne.md
- documentation/functions/workspace-one-access/Install-WorkspaceOneCertificate.md
- documentation/functions/workspace-one-access/Request-WSAToken.md
- documentation/functions/workspace-one-access/Set-WorkspaceOneApplianceNtpConfig.md
- documentation/functions/workspace-one-access/Set-WorkspaceOneDnsConfig.md
Expand Down

0 comments on commit 157c75d

Please sign in to comment.