docs: update project docs (#231)

tenthirtyam · web-flow · commit fe6af5bb3408 · 2025-04-15T14:43:10.000-04:00
Updates information about the project.

Signed-off-by: Ryan Johnson &lt;ryan.johnson@broadcom.com&gt;
diff --git a/README.md b/README.md
@@ -12,61 +12,57 @@
 
 ## Overview
 
-`VMware.CloudFoundation.PasswordManagement` is a PowerShell module that has been written to support the ability to report and configure the password policy settings across your [VMware Cloud Foundation][docs-vmware-cloud-foundation] instance.
+`VMware.CloudFoundation.PasswordManagement` is a PowerShell module designed to help you report on
+and manage password policy settings within your VMware Cloud Foundation environment.
 
-With these cmdlets, you can perform the following actions on a VMware Cloud Foundation instance or a specific workload domain.
+Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific
+workload domain.
 
-- Generate a password policy report for password expiration, password complexity, and account lockout.
-- Generate a password policy report with configuration drift using a password policy configuration file.
-- Update the password polices using a password policy configuration file.
-- Generate a password rotation report for all accounts managed by SDDC Manager.
+- Generate detailed password policy reports, including information on password expiration,
+  complexity, and account lockout settings.
+- Identify configuration drift by generating password policy reports using a predefined configuration file.
+- Update password policies seamlessly using a password policy configuration file.
+- Create comprehensive password rotation reports for all accounts managed by SDDC Manager.
 
 ## Documentation
 
-Please refer to the [documentation][docs-module] for more information on how to use this module.
+For detailed instructions on using this module, refer to the [official documentation][docs-module].
 
 ## Contributing
 
-The project team welcomes contributions from the community. Please read our [Developer Certificate of Origin][vmware-cla-dco]. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
-
-For more detailed information, refer to the [contribution guidelines][contributing] to get started.
+We encourage community contributions! To get started, please refer to the [contribution guidelines][contributing].
 
 ## Support
 
-While this module is not supported by VMware Support Services, it is supported by the project maintainers and its community of users.
+This module is community-driven and maintained by the project contributors. It is not officially
+supported by Broadcom Support but thrives on collaboration and input from its users.
 
-Use the GitHub [issues][gh-issues] to report bugs or suggest features and enhancements. Issues are monitored by the maintainers and are prioritized based on criticality and community [reactions][gh-reactions].
+Use the GitHub [issues][gh-issues] to report bugs or suggest features and enhancements. Issues are
+monitored by the maintainers and are prioritized based on criticality and community [reactions][gh-reactions].
 
-Before filing an issue, please search the issues and use the reactions feature to add votes to matching issues. Please include as much information as you can. Details like these are incredibly useful in helping the us evaluate and prioritize any changes:
+Before filing an issue, please search the issues and use the reactions feature to add votes to
+matching issues. Please include as much information as you can. Details like these are incredibly
+useful in helping the us evaluate and prioritize any changes:
 
 - A reproducible test case or series of steps.
 - Any modifications you've made relevant to the bug.
 - Anything unusual about your environment or deployment.
 
-You can also start a discussion on the GitHub [discussions][gh-discussions] area to ask questions or share ideas.
+You can also start a discussion on the GitHub [discussions][gh-discussions] area to ask questions or
+share ideas.
 
 ## License
 
 © Broadcom. All Rights Reserved.
-The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
-SPDX-License-Identifier: BSD-2
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
 
-[//]: Links
+This project is licensed under the [BSD 2-Clause License](LICENSE).
 
 [changelog]: CHANGELOG.md
 [contributing]: CONTRIBUTING.md
 [docs-module]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-password-management
-[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation
 [gh-discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/discussions
 [gh-issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues
 [gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
 [psgallery-module]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.PasswordManagement
-[vmware-cla-dco]: https://cla.vmware.com/dco
diff --git a/docs/community/support.md b/docs/community/support.md
@@ -1,18 +1,25 @@
 # Support
 
-:octicons-heart-24: &nbsp; While this module is not supported by VMware Support Services, it is supported by the project maintainers and its community of users.
+:octicons-heart-24: &nbsp; This module is community-driven and maintained by the project
+contributors. It is not officially supported by Broadcom Support but thrives on collaboration and
+input from its users.
 
-:octicons-issue-opened-24: &nbsp; Use the GitHub [issues][issues] to report bugs or suggest enhancements.
+:octicons-issue-opened-24: &nbsp; Use the GitHub [issues][issues] to report bugs or suggest
+enhancements.
 
-:octicons-thumbsup-24: &nbsp; Issues are monitored by the maintainers and are prioritized based on criticality and community [reactions][reactions].
+:octicons-thumbsup-24: &nbsp; Issues are monitored by the maintainers and are prioritized based on
+criticality and community [reactions][reactions].
 
-:octicons-search-24: &nbsp; Before opening an issue, please [search the issues][issues-search] and use the reactions to add votes to matching issues. Please include as much information as you can. Details like these are incredibly useful in helping the us evaluate and prioritize any changes:
+:octicons-search-24: &nbsp; Before opening an issue, please [search the issues][issues-search] and
+use the reactions to add votes to matching issues. Please include as much information as you can.
+Details like these are incredibly useful in helping the us evaluate and prioritize any changes:
 
 - A reproducible test case or series of steps.
 - Any modifications you've made relevant to the bug.
 - Anything unusual about your environment or deployment.
 
-:octicons-comment-discussion-24: &nbsp; You can also start a discussion on the GitHub [discussions][discussions] area to ask questions or share ideas.
+:octicons-comment-discussion-24: &nbsp; You can also start a discussion on the GitHub [discussions][discussions]
+area to ask questions or share ideas.
 
 [issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues
 [issues-search]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues?q=is%3Aissue+is%3Aopen+label%3Abug
diff --git a/docs/documentation/index.md b/docs/documentation/index.md
@@ -1,17 +1,20 @@
 <!-- markdownlint-disable first-line-h1 no-inline-html -->
 # Reference
 
-`VMware.CloudFoundation.PasswordManagement` is a PowerShell module that supports the ability to report and configure the password policy settings across your [VMware Cloud Foundatiоn][docs-vmware-cloud-foundation] instance.
+`VMware.CloudFoundation.PasswordManagement` is a PowerShell module designed to help you report on
+and manage password policy settings within your VMware Cloud Foundation environment.
 
-With these cmdlets, you can perform the following actions on a VMware Cloud Foundation instance or a specific workload domain.
+Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific
+workload domain.
 
 The module provides coverage for the following:
 
 === ":material-shield-check: &nbsp; Password Policies"
 
-    1. Generate a password policy report for password expiration, password complexity, and account lockout.
-    2. Generate a password policy report with configuration drift using a password policy configuration file.
-    3. Update the password polices using a password policy configuration file.
+    1. Generate detailed password policy reports, including information on password expiration, complexity, and account lockout settings.
+    2. Identify configuration drift by generating password policy reports using a predefined configuration file.
+    3. Update password policies seamlessly using a password policy configuration file.
+    4. Create comprehensive password rotation reports for all accounts managed by SDDC Manager.
 
     Components:
 
@@ -48,6 +51,3 @@ The module provides coverage for the following:
     ???+ note "Note"
         - VMware ESX password rotation is not managed by SDDC Manager.
         - VMware Aria Suite password rotation is only supported if deployed in VMware Cloud Foundation mode and present in the SDDC Manager inventory.
-
-
-[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
diff --git a/docs/index.md b/docs/index.md
@@ -6,17 +6,20 @@
 
 [:material-powershell: &nbsp; PowerShell Gallery][psgallery-module-password-management]{ .md-button .md-button--primary }
 
-`VMware.CloudFoundation.PasswordManagement` is a PowerShell module that supports the ability to report and configure the password policy settings across your [VMware Cloud Foundatiоn][docs-vmware-cloud-foundation] instance.
+`VMware.CloudFoundation.PasswordManagement` is a PowerShell module designed to help you report on
+and manage password policy settings within your VMware Cloud Foundation environment.
 
-With these cmdlets, you can perform the following actions on a VMware Cloud Foundation instance or a specific workload domain.
+Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific
+workload domain.
 
 The module provides coverage for the following:
 
 === ":material-shield-check: &nbsp; Password Policies"
 
-    1. Generate a password policy report for password expiration, password complexity, and account lockout.
-    2. Generate a password policy report with configuration drift using a password policy configuration file.
-    3. Update the password polices using a password policy configuration file.
+    1. Generate detailed password policy reports, including information on password expiration, complexity, and account lockout settings.
+    2. Identify configuration drift by generating password policy reports using a predefined configuration file.
+    3. Update password policies seamlessly using a password policy configuration file.
+    4. Create comprehensive password rotation reports for all accounts managed by SDDC Manager.
 
     Components:
 
@@ -66,17 +69,6 @@ Platform                                                     | Support
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-book: &nbsp; [Documentation][docs-vmware-cloud-foundation-ppm-5-1]
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-book: &nbsp; [Documentation][docs-vmware-cloud-foundation-ppm-5-0]
 :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-book: &nbsp; [Documentation][docs-vmware-cloud-foundation-ppm-4-5]
-:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green } | Not Available
-
-### Operating Systems
-
-The following table lists the supported operating systems for this module.
-
-Operating System                                                       | Version
------------------------------------------------------------------------|-----------
-:fontawesome-brands-windows: &nbsp; Microsoft Windows Server           | 2019, 2022
-:fontawesome-brands-windows: &nbsp; Microsoft Windows                  | 10, 11
-:fontawesome-brands-linux: &nbsp; [VMware Photon OS][github-os-photon] | 3.0, 4.0
 
 ### PowerShell
 
@@ -97,19 +89,17 @@ PowerShell Module                                    | Version   | Publisher | R
 [PowerVCF][psgallery-module-powervcf]                | >= 2.4.1  | Broadcom  | :fontawesome-solid-book: &nbsp; [Documentation][docs-module-powervcf]
 [PowerValidatedSolutions][psgallery-module-pvs]      | >= 2.12.1 | Broadcom  | :fontawesome-solid-book: &nbsp; [Documentation][docs-module-pvs]
 
-[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
-[docs-vmware-cloud-foundation-ppm-5-2]: https://docs.vmware.com/en/VMware-Cloud-Foundation/5.2/vcf-operations/GUID-18A95158-30F5-460F-AF80-33F25B6533D0.html
-[docs-vmware-cloud-foundation-ppm-5-1]: https://docs.vmware.com/en/VMware-Cloud-Foundation/5.1/vcf-operations/GUID-18A95158-30F5-460F-AF80-33F25B6533D0.html
-[docs-vmware-cloud-foundation-ppm-5-0]: https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/vcf-operations/GUID-18A95158-30F5-460F-AF80-33F25B6533D0.html
-[docs-vmware-cloud-foundation-ppm-4-5]: https://docs.vmware.com/en/VMware-Cloud-Foundation/4.5/vcf-operations/GUID-18A95158-30F5-460F-AF80-33F25B6533D0.html
+[docs-vmware-cloud-foundation-ppm-5-2]: https://techdocs.broadcom.com/us/en/vmware-cis/vcf/vcf-5-2-and-earlier/5-2/vmware-cloud-foundation-operations-5-2.html
+[docs-vmware-cloud-foundation-ppm-5-1]: https://techdocs.broadcom.com/us/en/vmware-cis/vcf/vcf-5-2-and-earlier/5-1/vmware-cloud-foundation-operations-5-1.html
+[docs-vmware-cloud-foundation-ppm-5-0]: https://techdocs.broadcom.com/us/en/vmware-cis/vcf/vcf-5-2-and-earlier/5-0/vmware-cloud-foundation-operations-5-0.html
+[docs-vmware-cloud-foundation-ppm-4-5]: https://techdocs.broadcom.com/us/en/vmware-cis/vcf/vcf-5-2-and-earlier/4-5/vmware-cloud-foundation-operations-4-5.html
 [microsoft-powershell]: https://docs.microsoft.com/en-us/powershell
 [psgallery-module-powercli]: https://www.powershellgallery.com/packages/VMware.PowerCLI
 [psgallery-module-powervcf]: https://www.powershellgallery.com/packages/PowerVCF
 [psgallery-module-password-management]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.PasswordManagement
 [psgallery-module-pvs]: https://www.powershellgallery.com/packages/PowerValidatedSolutions
 [psgallery-module-ssoadmin]: https://www.powershellgallery.com/packages/VMware.vSphere.SsoAdmin
-[developer-module-powercli]: https://developer.vmware.com/tool/vmware-powercli
+[developer-module-powercli]: https://developer.broadcom.com/powercli
 [docs-module-powervcf]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation
 [docs-module-pvs]: https://vmware.github.io/power-validated-solutions-for-cloud-foundation
 [github-module-ssoadmin]: https://github.com/vmware/PowerCLI-Example-Scripts/tree/master/Modules/VMware.vSphere.SsoAdmin
-[github-os-photon]: https://vmware.github.io/photon/
