Skip to content

Commit 7e8ca1f

Browse files
authored
docs: update docs (#24)
Updates the documentation. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 0a16cb5 commit 7e8ca1f

5 files changed

Lines changed: 22 additions & 28 deletions

File tree

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Copyright 2024 Broadcom. All Rights Reserved.
1+
# © Broadcom. All Rights Reserved.
2+
# The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
23
# SPDX-License-Identifier: BSD-2
34

45
docs-install:

docs/community/index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,3 @@ This PowerShell module is the work of many contributors and the project team app
44

55
Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or
66
additional documentation, we greatly value feedback and contributions from our community.
7-
8-
Name | Role | GitHub |
9-
----------------|--------------|-----------------------------------------------------------------|
10-
Ken Gould | Maintainer | [:fontawesome-brands-github:](https://github.com/feardamhan) |
11-
Brian O'Connell | Maintainer | [:fontawesome-brands-github:](https://github.com/LifeOfBrianOC) |

docs/community/support.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
# Support
22

3-
: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.
3+
:octicons-heart-24: &nbsp; This module is community-driven and maintained by the project
4+
contributors. It is not officially supported by Broadcom Support but thrives on collaboration and
5+
input from its users.
46

5-
:octicons-issue-opened-24: &nbsp; Use the GitHub [issues][issues] to report bugs or suggest enhancements.
7+
:octicons-issue-opened-24: &nbsp; Use the GitHub [issues][issues] to report bugs or suggest
8+
enhancements.
69

7-
:octicons-thumbsup-24: &nbsp; Issues are monitored by the maintainers and are prioritized based on criticality and community [reactions][reactions].
10+
:octicons-thumbsup-24: &nbsp; Issues are monitored by the maintainers and are prioritized based on
11+
criticality and community [reactions][reactions].
812

9-
: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:
13+
:octicons-search-24: &nbsp; Before opening an issue, please [search the issues][issues-search] and
14+
use the reactions to add votes to matching issues. Please include as much information as you can.
15+
Details like these are incredibly useful in helping the us evaluate and prioritize any changes:
1016

1117
- A reproducible test case or series of steps.
1218
- Any modifications you've made relevant to the bug.
1319
- Anything unusual about your environment or deployment.
1420

15-
:octicons-comment-discussion-24: &nbsp; You can also start a discussion on the GitHub [discussions][discussions] area to ask questions or share ideas.
21+
:octicons-comment-discussion-24: &nbsp; You can also start a discussion on the GitHub [discussions][discussions]
22+
area to ask questions or share ideas.
1623

1724
[discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/discussions
1825
[issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/issues

docs/index.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
# PowerShell Module for VMware Cloud Foundation Instance Recovery
66

7-
`VMware.CloudFoundation.InstanceRecovery` is a PowerShell module that has been written to support the ability to automate and accelerate the recovery of a [VMware Cloud Foundation][docs-vmware-cloud-foundation] instance through the use of
8-
PowerShell cmdlets.
7+
`VMware.CloudFoundation.InstanceRecovery` is a PowerShell module that has been written to support
8+
the ability to automate and accelerate the recovery of a VMware Cloud Foundation instance through
9+
the use of PowerShell cmdlets.
910

1011
[:material-powershell: &nbsp; PowerShell Gallery][psgallery-module-recovery]{ .md-button .md-button--primary }.
1112

12-
## Requirements.
13+
## Requirements
1314

1415
### Platforms
1516

@@ -23,15 +24,6 @@ Platform | Support
2324
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green }
2425
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green }
2526

26-
27-
### Operating Systems
28-
29-
The following table lists the supported operating systems for this module.
30-
31-
Operating System | Version
32-
---------------------------------------------------------------------|---------
33-
:fontawesome-brands-windows: &nbsp; Microsoft Windows Server | 2019
34-
3527
### PowerShell
3628

3729
The following table lists the supported editions and versions of PowerShell for this module.
@@ -51,13 +43,12 @@ Dependency | Version | Publisher
5143
[7Zip4Powershell][psgallery-module-7zip4powershell] | 2.4.0 | Thomas Freudenberg | :fontawesome-brands-github: &nbsp; [GitHub][github-module-7zip4powershell]
5244
[OpenSSL for Windows][download-win64openssl] | 3.2.1 | Shining Light Productions | :octicons-package-dependencies-24: &nbsp; [Download][download-win64openssl]
5345

54-
[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
5546
[microsoft-powershell]: https://docs.microsoft.com/en-us/powershell
5647
[psgallery-module-7zip4powershell]: https://www.powershellgallery.com/packages/7Zip4Powershell
5748
[psgallery-module-poshssh]: https://www.powershellgallery.com/packages/Posh-SSH
5849
[psgallery-module-powercli]: https://www.powershellgallery.com/packages/VMware.PowerCLI
5950
[psgallery-module-recovery]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.InstanceRecovery
60-
[developer-module-powercli]: https://developer.vmware.com/tool/vmware-powercli
51+
[developer-module-powercli]: https://developer.broadcom.com/powercli
6152
[docs-module-powervcf]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation
6253
[github-module-7zip4powershell]: https://github.com/thoemmi/7Zip4Powershell
6354
[github-module-poshssh]: https://github.com/darkoperator/Posh-SSH

docs/snippets/vars-vcf.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
$sddcManagerFqdn = "sfo-vcf01.sfo.rainpole.io"
2-
$sddcManagerUser = "admin@local"
3-
$sddcManagerPass = "VMw@re1!VMw@re1!"
1+
$sddcManagerFqdn = "[sddc_manager_fqdn]"
2+
$sddcManagerUser = "[admin_username]"
3+
$sddcManagerPass = "[admin_password]"

0 commit comments

Comments
 (0)