Skip to content

Commit 525abfa

Browse files
Update docs for release (#46)
1 parent d3c386a commit 525abfa

File tree

7 files changed

+92
-28
lines changed

7 files changed

+92
-28
lines changed

.github/SECURITY.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,24 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

1118
# Security policy
1219

1320
The Terraform Provider for Dell PowerFlex repository is inspected for security vulnerabilities via blackduck scans and static code analysis.
1421

15-
In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](https://github.com/dell/terraform-provider-powerflex/blob/main/CONTRIBUTING.md#Pull-requests) for more information.
22+
In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](../about/CONTRIBUTING.md#Pull-requests) for more information.
1623

1724
## Reporting a vulnerability
1825

1926
Have you discovered a security vulnerability in this project?
2027
We ask you to alert the maintainers by sending an email, describing the issue, impact, and fix - if applicable.
2128

22-
You can reach the Terraform providers for Dell PowerFlex maintainers at ses.avengers@dell.com.
29+
You can reach the Terraform providers for Dell PowerFlex maintainers at tpfdi.team@dell.com.

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,39 @@
1+
<!--
2+
Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
3+
4+
Licensed under the Mozilla Public License Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
117
# Terraform Provider for Dell Technologies PowerFlex
218

19+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](about/CODE_OF_CONDUCT.md)
20+
[![License](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](LICENSE)
21+
322
The Terraform Provider for Dell Technologies (Dell) PowerFlex allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerFlex storage systems.
423

524
The Terraform Provider can be used to manage SDCs, volumes, snapshots, snapshot-policies, storage pools, SDSs and protection domains.
625

726
## Table of contents
827

9-
* [Support](https://github.com/dell/terraform-provider-powerflex/blob/main/about/SUPPORT.md)
28+
* [Support](about/SUPPORT.md)
1029
* [License](#license)
1130
* [Prerequisites](#prerequisites)
1231
* [List of DataSources in Terraform Provider for Dell PowerFlex](#list-of-datasources-in-terraform-provider-for-dell-powerflex)
1332
* [List of Resources in Terraform Provider for Dell PowerFlex](#list-of-resources-in-terraform-provider-for-dell-powerflex)
1433
* [Releasing, Maintenance and Deprecation](#releasing-maintenance-and-deprecation)
1534

1635
## License
17-
The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 license. See [LICENSE](https://github.com/dell/terraform-provider-powerflex/blob/main/LICENSE) for the full terms.
36+
The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 license. See [LICENSE](LICENSE) for the full terms.
1837

1938
## Prerequisites
2039

@@ -23,22 +42,22 @@ The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 l
2342
| v1.0.0 | 3.6 | ubuntu22.04 <br> rhel8.x <br> rhel7.x | 1.3.2 <br> 1.2.9 <br> | 1.19.x
2443

2544
## List of DataSources in Terraform Provider for Dell PowerFlex
26-
* [SDC](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/sdc.md)
27-
* [Storage pool](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/storagepool.md)
28-
* [Volume](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/volume.md)
29-
* [SDS](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/sds.md)
30-
* [Protection Domain](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/protection_domain.md)
31-
* [Snapshot Policy](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/protection_domain.md)
45+
* [SDC](docs/data-sources/sdc.md)
46+
* [Storage pool](docs/data-sources/storagepool.md)
47+
* [Volume](docs/data-sources/volume.md)
48+
* [SDS](docs/data-sources/sds.md)
49+
* [Protection Domain](docs/data-sources/protection_domain.md)
50+
* [Snapshot Policy](docs/data-sources/protection_domain.md)
3251

3352
## List of Resources in Terraform Provider for Dell PowerFlex
34-
* [SDC](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/sdc.md)
35-
* [Storage pool](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/storagepool.md)
36-
* [Volume](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/volume.md)
37-
* [SDS](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/sds.md)
38-
* [Snapshot](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/snapshot.md)
53+
* [SDC](docs/resources/sdc.md)
54+
* [Storage pool](docs/resources/storagepool.md)
55+
* [Volume](docs/resources/volume.md)
56+
* [SDS](docs/resources/sds.md)
57+
* [Snapshot](docs/resources/snapshot.md)
3958

4059
## Installation and execution of Terraform Provider for Dell PowerFlex
41-
The installation and execution steps of Terraform Provider for Dell PowerFlex can be found [here](https://github.com/dell/terraform-provider-powerflex/blob/main/about/INSTALLATION.md).
60+
The installation and execution steps of Terraform Provider for Dell PowerFlex can be found [here](about/INSTALLATION.md).
4261

4362
## Releasing, Maintenance and Deprecation
4463

about/CODE_OF_CONDUCT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

1118
# Code of conduct - contributor covenant

about/COMMITTER_GUIDE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

1118
# Committer guidelines

about/CONTRIBUTING.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

1118
# How to contribute
1219

13-
Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/terraform-provider-powerflex/blob/main/CODE_OF_CONDUCT.md).
20+
Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
1421

1522
## Table of contents
1623

@@ -36,15 +43,15 @@ You can contribute to this project in several ways. Here are some examples:
3643

3744
## Submitting issues
3845

39-
All issues related to Terraform provider for Dell PowerFlex, regardless of the service/repository the issue belongs to (see table above), should be submitted [here](https://github.com/dell/terraform-provider-powerflex/issues). Issues will be triaged and labels will be used to indicate the type of issue. This section outlines the types of issues that can be submitted.
46+
All issues related to Terraform provider for Dell PowerFlex, regardless of the service/repository the issue belongs to (see table above), should be submitted [here](https://github.com/dell/dell-terraform-providers/issues). Issues will be triaged and labels will be used to indicate the type of issue. This section outlines the types of issues that can be submitted.
4047

4148
### Report bugs
4249

4350
We aim to track and document everything related to Terraform provider for Dell PowerFlex via the Issues page. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.
4451

45-
Before submitting a new issue, make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/dell/terraform-provider-powerflex/issues) for similar issues.
52+
Before submitting a new issue, make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/dell/dell-terraform-providers/issues) for similar issues.
4653

47-
Report a bug by submitting a [bug report](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Fbug%2C+needs-triage&template=bug_report.md&title=%5BBUG%5D%3A). Make sure that you provide as much information as possible on how to reproduce the bug.
54+
Report a bug by submitting a [bug report](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Fbug%2C+needs-triage&template=bug_report.md&title=%5BBUG%5D%3A). Make sure that you provide as much information as possible on how to reproduce the bug.
4855

4956
When opening a Bug please include this information to help with debugging:
5057

@@ -57,11 +64,11 @@ An Issue __must__ be created before submitting any pull request. Any pull reques
5764

5865
### Feature request
5966

60-
If you have an idea of how to improve this project, submit a [feature request](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Ffeature-request%2C+needs-triage&template=feature_request.md&title=%5BFEATURE%5D%3A).
67+
If you have an idea of how to improve this project, submit a [feature request](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Ffeature-request%2C+needs-triage&template=feature_request.md&title=%5BFEATURE%5D%3A).
6168

6269
### Answering questions
6370

64-
If you have a question and you can't find the answer in the documentation or issues, the next step is to submit a [question.](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Fquestion&template=ask-a-question.md&title=%5BQUESTION%5D%3A)
71+
If you have a question and you can't find the answer in the documentation or issues, the next step is to submit a [question.](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Fquestion&template=ask-a-question.md&title=%5BQUESTION%5D%3A)
6572

6673
We'd love your help answering questions being asked by other Terraform provider for Dell PowerFlex users.
6774

@@ -76,14 +83,14 @@ Triage helps ensure that issues resolve quickly by:
7683

7784
If you don't have the knowledge or time to code, consider helping with _issue triage_. The Terraform provider for Dell PowerFlex community will thank you for saving them time by spending some of yours.
7885

79-
Read more about the ways you can [Triage issues](https://github.com/dell/terraform-provider-powerflex/blob/main/ISSUE_TRIAGE.md).
86+
Read more about the ways you can [Triage issues](ISSUE_TRIAGE.md).
8087

8188
## Your first contribution
8289

8390
Unsure where to begin contributing? Start by browsing issues labeled `beginner friendly` or `help wanted`.
8491

85-
* [Beginner-friendly](https://github.com/dell/terraform-provider-powerflex/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete.
86-
* [Help wanted](https://github.com/dell/terraform-provider-powerflex/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity.
92+
* [Beginner-friendly](https://github.com/dell/dell-terraform-providers/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete.
93+
* [Help wanted](https://github.com/dell/dell-terraform-providers/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity.
8794

8895
When you're ready to contribute, it's time to create a pull request.
8996

@@ -140,7 +147,7 @@ Make sure that the title for your pull request uses the same format as the subje
140147

141148
### Quality gates for pull requests
142149

143-
GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/terraform-provider-powerflex/blob/main/SUPPORT.md).
150+
GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](SUPPORT.md).
144151

145152
#### Code sanitization
146153

about/INSTALLATION.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

1118
# Installation of Terraform Provider for Dell PowerFlex

about/SUPPORT.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,17 @@ you may not use this file except in compliance with the License.
66
You may obtain a copy of the License at
77
88
http://mozilla.org/MPL/2.0/
9+
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
916
-->
1017

11-
## Support
12-
For all your support needs you can interact with us on [GitHub](https://github.com/dell/terraform-provider-powerflex) by creating a [GitHub Issue](https://github.com/dell/terraform-provider-powerflex/issues) or by sending email to [email protected].
18+
# Support
19+
20+
For all your support needs or to follow the latest ongoing discussions and updates, join our Slack group. Click [Here](./) to request your invite.
21+
22+
You can also interact with us on [GitHub](https://github.com/dell/dell-terraform-providers) by creating a [GitHub Issue](https://github.com/dell/dell-terraform-providers/issues).

0 commit comments

Comments
 (0)