Skip to content

Commit 6aa3fb4

Browse files
authored
docs: update supported versions (#26)
Updates supported versions. Signed-off-by: Ryan Johnson <[email protected]>
1 parent 76f55ab commit 6aa3fb4

File tree

3 files changed

+25
-46
lines changed

3 files changed

+25
-46
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ body:
2929
id: version-vcf
3030
attributes:
3131
label: VMware Cloud Foundation
32-
description: Please provide the VMware Cloud Foundation version.
33-
placeholder: x.y.z
32+
description: >
33+
Please provide the VMware Cloud Foundation version.
34+
35+
For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation](https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-instance-recovery/).
36+
placeholder: x.y.z
3437
validations:
3538
required: true
3639
- type: input
@@ -41,7 +44,7 @@ body:
4144
Please provide the PowerShell version.
4245
4346
Results of: `$PSVersionTable`
44-
placeholder: Windows PowerShell 5.1
47+
placeholder: PowerShell 7
4548
validations:
4649
required: true
4750
- type: input

README.md

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,28 @@
88
[<img src="https://img.shields.io/badge/Changelog-Read-blue?style=for-the-badge&logo=github&logoColor=white" alt="CHANGELOG" >][changelog]
99

1010
[<img src="https://img.shields.io/powershellgallery/v/VMware.CloudFoundation.InstanceRecovery?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell Gallery">][psgallery-module]&nbsp;&nbsp;
11-
<img src="https://img.shields.io/powershellgallery/dt/VMware.CloudFoundation.InstanceRecovery?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell Gallery Downloads">.
11+
<img src="https://img.shields.io/powershellgallery/dt/VMware.CloudFoundation.InstanceRecovery?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell Gallery Downloads">
1212

1313
## Overview
1414

1515
`VMware.CloudFoundation.InstanceRecovery` is a PowerShell module that has been written to support
16-
the ability to automate and accelerate the recovery of a [VMware Cloud Foundation][docs-vmware-cloud-foundation]
17-
instance through the use of PowerShell cmdlets.
16+
the ability to automate and accelerate the recovery of a VMware Cloud Foundation instance through
17+
the use of PowerShell cmdlets.
18+
19+
For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation][docs-module].
1820

1921
## Documentation
2022

21-
Please refer to the [documentation][docs-module] for more information on how to use this module.
23+
For detailed instructions on using this module, refer to the [documentation][docs-module].
2224

2325
## Contributing
2426

25-
The project team welcomes contributions from the community. Before you start working with project,
26-
please read our [Developer Certificate of Origin][vmware-cla-dco].
27-
28-
All contributions to this repository must be signed as described on that page. Your signature
29-
certifies that you wrote the patch or have the right to pass it on as an open-source patch.
30-
31-
For more detailed information, refer to the [contribution guidelines][contributing] to get started.
27+
We encourage community contributions! To get started, please refer to the [contribution guidelines][contributing].
3228

3329
## Support
3430

35-
While this module is not supported by VMware Support Services, it is supported by the project
36-
maintainers and its community of users.
31+
This module is community-driven and maintained by the project contributors. It is not officially
32+
supported by Broadcom Support but thrives on collaboration and input from its users.
3733

3834
Use the GitHub [issues][gh-issues] to report bugs or suggest features and enhancements. Issues are
3935
monitored by the maintainers and are prioritized based on criticality and community [reactions][gh-reactions].
@@ -51,35 +47,18 @@ share ideas.
5147

5248
## License
5349

54-
Copyright 2024 Broadcom. All Rights Reserved.
55-
56-
Redistribution and use in source and binary forms, with or without modification, are permitted
57-
provided that the following conditions are met:
58-
59-
1. Redistributions of source code must retain the above copyright notice, this list of conditions
60-
and the following disclaimer.
50+
© Broadcom. All Rights Reserved.
6151

62-
1. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
63-
and the following disclaimer in the documentation and/or other materials provided with the
64-
distribution.
52+
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
6553

66-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
67-
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
68-
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
69-
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE,
71-
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
72-
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
73-
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54+
This project is licensed under the [BSD 2-Clause License](LICENSE).
7455

7556
[//]: Links
7657

7758
[changelog]: CHANGELOG.md
78-
[contributing]: CONTRIBUTING.md
79-
[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation
59+
[contributing]: CONTRIBUTING.m
8060
[docs-module]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-instance-recovery
8161
[gh-discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/discussions
8262
[gh-issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/issues
8363
[gh-reactions]: https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
8464
[psgallery-module]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.InstanceRecovery
85-
[vmware-cla-dco]: https://cla.vmware.com/dco

docs/index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,14 @@ the use of PowerShell cmdlets.
1212

1313
## Requirements
1414

15-
### Platforms
15+
### VMware Cloud Foundation
1616

17-
The following table lists the supported platforms for this module.
17+
The following table lists the supported releases for this module.
1818

19-
Platform | Support
20-
-------------------------------------------------------------|------------------------------------
21-
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.2 | :fontawesome-solid-check:{ .green }
22-
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green }
23-
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green }
24-
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green }
25-
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green }
19+
| Platform | Support |
20+
|--------------------------------------------------------------| ----------------------------------- |
21+
| :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.2 | :fontawesome-solid-check:{ .green } |
22+
| :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } |
2623

2724
### PowerShell
2825

0 commit comments

Comments
 (0)