Skip to content

Commit

Permalink
Feature/add documentation files (#26)
Browse files Browse the repository at this point in the history
* add documentation for contribution

* remove contribution from readme

* add some minio doc for resources
  • Loading branch information
aminueza committed Jan 28, 2020
1 parent 4255abf commit 4944279
Show file tree
Hide file tree
Showing 8 changed files with 270 additions and 25 deletions.
6 changes: 6 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Authors #

----------
- Amanda Souza : DevOps Engineer ([amanda@amandasouza.app](mailto:amanda@amandasouza.app))
- Victor Nogueira: Senior Game Developer ([victor@victornogueira.app](mailto:victor@victornogueira.app))
- Nolte
34 changes: 9 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

<!-- PROJECT LOGO -->
<p align="center">
<a href="https://github.com/aminueza/terraform-minio-provider">
<a href="https://github.com/aminueza/terraform-provider-minio">
<img src="https://i.imgur.com/yijdDec.png" alt="minio-provider-terraform" width="200">
</a>
<h3 align="center" style="font-weight: bold">Terraform Provider for MinIO</h3>
<p align="center">
<a href="https://github.com/aminueza/terraform-minio-provider/tree/master/docs"><strong>Explore the docs »</strong></a>
<a href="https://github.com/aminueza/terraform-provider-minio/tree/master/docs"><strong>Explore the docs »</strong></a>
</p>
</p>

Expand All @@ -21,9 +21,7 @@
* [Examples](#examples)
* [Testing](#testing)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)

<!-- ABOUT THE PROJECT -->
Expand Down Expand Up @@ -101,35 +99,21 @@ For testing locally, run the docker compose to spin up a minio server:
```sh
$ docker-compose up
```
<!-- ROADMAP -->
## Roadmap

See the [open issues](https://github.com/aminueza/terraform-minio-provider/issues) for a list of proposed features (and known issues).
<!-- USAGE -->
## Usage

<!-- CONTRIBUTING -->
## Contributing
See our [Examples](examples/) folder.

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated** <span style="color: #e25555;">&#9829;</span>.
<!-- ROADMAP -->
## Roadmap

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/TerraformFeature`)
3. Commit your Changes (`git commit -m 'Add some TerraformFeature'`)
4. Push to the Branch (`git push origin feature/TerraformFeature`)
5. Open a [Pull Request](https://github.com/aminueza/terraform-minio-provider/pulls)
See the [open issues](https://github.com/aminueza/terraform-minio-provider/issues) for a list of proposed features (and known issues). See [CONTRIBUTION.md](./docs/github/CONTRIBUTING.md) for more information.

<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE` for more information.

<!-- CONTACT -->
## Contact

**Amanda Souza** ([amandasouza.app](https://amandasouza.app))

**Email:** [amanda@amandasouza.app](amanda@amandasouza.app)

**Project Link:** [https://github.com/aminueza/terraform-minio-provider](https://github.com/aminueza/terraform-minio-provider)
Distributed under the Apache License. See `LICENSE` for more information.

<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
Expand Down
30 changes: 30 additions & 0 deletions docs/IAM_GROUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## IAM GROUP

Provides an IAM group.

## Example of usage

```hcl
resource "minio_iam_group" "developer" {
name = "developer"
}
output "minio_user_group" {
value = "${minio_iam_group.developer.group_name"
}
```

## Argument Reference

The following arguments are supported:

* **name** - (Required) The group's name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create group named both "ADMINS" and "admins".
* **force_destroy** - (Optional, default false) When destroying this group, destroy even if it has users and polices attached. Without force_destroy a group will fail to be destroyed.
* **disable_group** - (Optional, default false) Disable a group. If the group is disabled and you add the flag equals to false, it enables a group back.

## Output

The following outputs are supported:

* **id** - (Optional) Returns a group's id. It's same of group name.
* **group_name** - (Optional) Returns a group's name. Same of group's id.
50 changes: 50 additions & 0 deletions docs/IAM_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## IAM POLIVY

Provides an IAM policy.

## Example of usage

```hcl
resource "minio_iam_policy" "test_policy" {
name = "state-terraform-s3"
policy= <<EOF
{
"Version":"2012-10-17",
"Statement": [
{
"Sid":"ListAllBucket",
"Effect": "Allow",
"Action": ["s3:PutObject"],
"Principal":"*",
"Resource": "arn:aws:s3:::state-terraform-s3/*"
}
]
}
EOF
}
output "minio_id" {
value = "${minio_iam_policy.test_policy.id}"
}
output "minio_policy" {
value = "${minio_iam_policy.test_policy.policy}"
}
```

## Argument Reference

The following arguments are supported:

* **name** - (Optional, Forces new resource) The name of the policy. If omitted, Terraform will assign a random, unique name.
* **policy** - (Required) The policy document. This is a JSON formatted string based on AWS policies.
* **name_prefix** - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with name.

## Output

The following outputs are supported:

* **id** - (Optional) Returns a policy's id. It's same of policy name.
* **name** - (Optional) Returns a policy's name. Same of policy's id.
* **policy** - (Optional) Returns a policy's json string.
91 changes: 91 additions & 0 deletions docs/github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Contributor Covenant Code of Conduct

## Summary

- Treat everyone with respect and kindness.
- Be thoughtful in how you communicate.
- Don’t be destructive or inflammatory.
- If you encounter an issue, please mail [amanda@amandasouza.app](amanda@amandasouza.app).

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [amanda@amandasouza.app](amanda@amandasouza.app). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
21 changes: 21 additions & 0 deletions docs/github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contribution Code
| for guideline := range guidelines {
Do Contribution
}

## Welcome

Thank you so much for considering to contribute!
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated** <span style="color: #e25555;">&#9829;</span>.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/TerraformFeature`)
3. Commit your Changes (`git commit -m 'Add some TerraformFeature'`)
4. Push to the Branch (`git push origin feature/TerraformFeature`)
5. Open a [Pull Request](https://github.com/aminueza/terraform-provider-minio/pulls)

### Merging

1. As soon as possible the authors will review your pull request, answering to your message.
2. **ALL CI tests** must be passed. <span style="color: #008000;">&#10004;</span>
3. Make sure you have added your name to the list of AUTHORS.md.
27 changes: 27 additions & 0 deletions docs/github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Prerequisites

- Be sure that theres no open issue already.

### Description

[Description of the issue]

### Steps to Reproduce

1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior:** [What you expect to happen]

**Actual behavior:** [What actually happens]

**Reproduces how often:** [What percentage of the time does it reproduce?]

### Versions

Not required yet

### Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.
36 changes: 36 additions & 0 deletions docs/github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
IMPORTANT: Please have a look at the contribution guidelines first.
-->
# A clear and descriptive title (No issue numbers please)

This PR implements the following changes:
<!--
Further paragraphs come after blank lines, if needed.
- Bullet points are okay, too
- A hyphen or asterisk is used for the bullet, preceded by a single space.
# Please provide enough information so that others can review your pull request:
# Explain the details for making this change. What existing problem does the pull request solve?
-->
## Reference
<!--
Please be aware, that every pull-request/merge-request for needs an issue.
-->
- Resolves: #12, #13
- See also: #33, #44

## (Optional) People
<!--
@mentions of somebody who was involved or should be involved.
@mentions of the person or team responsible for reviewing proposed changes.
-->

## Closing issues
<!--
Put closes #XXXX in your comment to auto-close the issue that your PR fixes (if such).
-->
- Closes: #XXX

**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**

0 comments on commit 4944279

Please sign in to comment.