Skip to content

docs: update supported versions #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tenthirtyam merged 1 commit into from
Jun 9, 2025
Merged

docs: update supported versions #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ body:
id: version-vcf
attributes:
label: VMware Cloud Foundation
description: Please provide the VMware Cloud Foundation version.
placeholder: x.y.z
description: >
Please provide the VMware Cloud Foundation version.

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/).
placeholder: x.y.z
validations:
required: true
- type: input
Expand All @@ -41,7 +44,7 @@ body:
Please provide the PowerShell version.

Results of: `$PSVersionTable`
placeholder: Windows PowerShell 5.1
placeholder: PowerShell 7
validations:
required: true
- type: input
Expand Down
47 changes: 13 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,28 @@
[<img src="https://img.shields.io/badge/Changelog-Read-blue?style=for-the-badge&logo=github&logoColor=white" alt="CHANGELOG" >][changelog]

[<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;
<img src="https://img.shields.io/powershellgallery/dt/VMware.CloudFoundation.InstanceRecovery?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell Gallery Downloads">.
<img src="https://img.shields.io/powershellgallery/dt/VMware.CloudFoundation.InstanceRecovery?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell Gallery Downloads">

## Overview

`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 PowerShell cmdlets.
the ability to automate and accelerate the recovery of a VMware Cloud Foundation instance through
the use of PowerShell cmdlets.

For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation][docs-module].

## 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 [documentation][docs-module].

## Contributing

The project team welcomes contributions from the community. Before you start working with project,
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].
Expand All @@ -51,35 +47,18 @@ share ideas.

## License

Copyright 2024 Broadcom. All Rights Reserved.

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.
© Broadcom. All Rights Reserved.

1. 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.
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

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.
This project is licensed under the [BSD 2-Clause License](LICENSE).

[//]: Links

[changelog]: CHANGELOG.md
[contributing]: CONTRIBUTING.md
[docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation
[contributing]: CONTRIBUTING.m
[docs-module]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-instance-recovery
[gh-discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/discussions
[gh-issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-instance-recovery/issues
[gh-reactions]: https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
[psgallery-module]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.InstanceRecovery
[vmware-cla-dco]: https://cla.vmware.com/dco
15 changes: 6 additions & 9 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,14 @@ the use of PowerShell cmdlets.

## Requirements

### Platforms
### VMware Cloud Foundation

The following table lists the supported platforms for this module.
The following table lists the supported releases for this module.

Platform | Support
-------------------------------------------------------------|------------------------------------
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.2 | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green }
:fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green }
| Platform | Support |
|--------------------------------------------------------------| ----------------------------------- |
| :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.2 | :fontawesome-solid-check:{ .green } |
| :fontawesome-solid-cloud: &nbsp; VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } |

### PowerShell

Expand Down