Skip to content

Commit 59d725d

Browse files
Add community files (#5)
* add community files * chore: update org banner image * chore: update repo banner image * update CODEOWNERS * update CODEOWNERS * build readme * build readme * build readme --------- Co-authored-by: screenshot-action 📷 <actions@github.com>
1 parent a02eb89 commit 59d725d

15 files changed

Lines changed: 1014 additions & 3 deletions

File tree

.github/CODEOWNERS

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Use this file to define individuals or teams that are responsible for code in a repository.
2+
# Read more: <https://help.github.com/articles/about-codeowners/>
3+
#
4+
# Order is important: the last matching pattern has the highest precedence
5+
6+
# To allow mergify to auto-merge, we must in general not assign code owners to files
7+
# This is because mergify will not be able to merge if the code owner is not a mergify admin.
8+
# Instead, we require mergify checks to pass before merging and re-implement CODEOWNERS
9+
# functionality in the mergify configuration.
10+
11+
12+
# Cloud Posse Admins must review all changes to CODEOWNERS or the mergify configuration
13+
.github/mergify.yml @cloudposse-github-actions/admins
14+
.github/CODEOWNERS @cloudposse-github-actions/admins

.github/banner.png

968 KB
Loading

.github/workflows/repo-banner.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
uses: cloudposse-github-actions/screenshot@main
2828
with:
2929
url: "file://${{github.workspace}}/banner/index.html"
30-
output: "banner/image.png"
30+
output: ".github/banner.png"
3131
customizations: |
3232
"#name": "${{ steps.metadata.outputs.repository_name }}"
3333
"#desc": "${{ steps.metadata.outputs.repository_description }}"

.gitignore

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
**/.DS_Store
1+
# Module directory
2+
.terraform
3+
.idea
4+
*.iml
5+
6+
.build-harness
7+
build-harness
8+
9+
**/.DS_Store

CODE_OF_CONDUCT.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Code of Conduct
2+
3+
This code of conduct governs the [SweetOps Slack Community](https://slack.sweetops.com/) and related [Open Source Projects](https://github.com/cloudposse). SweetOps is operated by Cloud Posse, a [DevOps Accelerator](https://devopsaccelerator.com/) based in Houston, TX.
4+
5+
> [!IMPORTANT]
6+
> **SweetOps is a collaborative DevOps community for engineers of all skill levels.**
7+
>
8+
> We want to make sure our community is as constructive as possible in order to help each other solve cool DevOps problems.
9+
> Anything that goes against the spirit of this, isn’t cool. If you see something suspicious, derogatory, or
10+
> otherwise inappropriate, etc. please send an email to [abuse@cloudposse.com](mailto:abuse@cloudposse.com) with details.
11+
>
12+
13+
## Introduction
14+
15+
We strive to be inclusive to the largest number of contributors, with as diverse backgrounds as possible. That is why we are committed to providing an environment that encourages friendly, safe and welcoming discussions for everyone interested in learning and sharing.
16+
17+
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
18+
19+
We invite all those who participate in SweetOps to help us create safe and positive experiences for everyone.
20+
21+
## Etiquette
22+
- Do not cross-post questions across multiple channels (pick one)
23+
- Do not ask questions in `#general`. Search channel instead or suggest one, if you can’t find one.
24+
- Use the professional language you would use at work. Avoid using profanity in any language.
25+
- Praise publicly (with tons of emojis!)
26+
- Criticize constructively, but never disparagingly (e.g. there are no “stupid” questions)
27+
- Practice empathy (e.g. “Ahk, that shouldn’t happen”)
28+
- Correct delicately (e.g. “Have you considered…”)
29+
- Avoid sarcasm, or feigning surprise (e.g. Don’t say “I’m surprised you didn’t know that”)
30+
- Seek to understand, not to embarrass, discredit or humiliate (e.g. “Hrmm… could you explain that another way? I’m not following.”)
31+
- When posting for the first time, review the channel history to get a sense of how others interact. Also, check out our “Guidelines When Asking for Help.”
32+
- Check out the channel’s topic and purpose in order to stay on point
33+
- Use the `#random` channel if nothing else fits
34+
- Use threads when responding, especially in busy channels
35+
- Don’t use `@channel` and `@here` (we’ve disabled them)
36+
37+
38+
## Unacceptable Behavior
39+
40+
The following are behaviors we consider forms of harassment that are unacceptable within our community:
41+
- Comments that may be considered sexist, racist, homophobic, transphobic or otherwise discriminatory or offensive in nature. (Everything you say in public is on the record)
42+
- Usernames that contain unwelcome, suggestive, derogatory or inappropriate terms.
43+
- Disrespect towards others is not tolerated.
44+
- Unprofessional jokes, innuendo, dismissive attitudes.
45+
- All forms of intimidation or harassment are prohibited.
46+
- Foul or obscene language (in any language!)
47+
- Disrespect towards differences of opinion.
48+
- Disparagement.
49+
- Deceptive or fraudulent activity.
50+
- Sustained disruptions (like spamming channels).
51+
- All forms of violence, threats of violence or violent language.
52+
53+
This is not an exhaustive list of things we prohibit. In order to preserve the spirit of this community, we reserve the right to use our discretion when applying disciplinary actions to behaviors we deem inappropriate.
54+
55+
## Solicitation
56+
57+
We only permit companies or individuals to solicit work, post jobs, or engage in self-promotion in the [#jobs](http://archive.sweetops.com/jobs/) channel [(archive)](http://archive.sweetops.com/jobs/). It is not acceptable to engage in this behavior in any other channel or to send unsolicited direct messages concerning job opportunities or job marketplaces. Under no circumstances is it acceptable to solicit payment from members for any reason (e.g. recruiting fees). The intent for the [#jobs](http://archive.sweetops.com/jobs/) channel [(archive)](http://archive.sweetops.com/jobs/) is for companies looking to make a direct-hire without intermediaries such as recruiters. Additionally, the promotion of any kind of third-party job marketplaces is not permitted. Any direct messages to members should be in relation to specific messages posted about job opportunities or candidates seeking work, but absolutely not for promoting other services. Recruiters may only reach out to individual candidates who have posted in the `#jobs` channel, but are not permitted to directly solicit members or companies in this community.
58+
59+
> [!IMPORTANT]
60+
> If you’ve received an unwelcome solicitation, please email [abuse@cloudposse.com](mailto:abuse@cloudposse.com) with details including screenshots.
61+
62+
## Privacy
63+
64+
All conversations that happen in our public Slack channels are published regularly to our [online archive](https://archive.sweetops.com/) and indexed by web crawlers like Google. For this reason, community members should not have any expectation of privacy in their use.
65+
66+
It’s the responsibility of our members to avoid sharing any information that might lead to loss or damages, such as breach of their company’s security protocols or sharing of intellectual property.
67+
68+
All direct messages are private. They not accessible by anyone on the Slack team, including moderators and administrators.
69+
70+
Your email address is private and will not be shared with anyone outside of Cloud Posse. From time to time, Slack (the Company) or Cloud Posse may send you notifications. If you are unable to opt-out for any reason, please let us know at [abuse@cloudposse.com](mailto:abuse@cloudposse.com).
71+
72+
Additionally, Slack (the Company) has its own [Privacy Policy](https://slack.com/privacy-policy) which affects all communities hosted on the platform.
73+
74+
## Logs and Records
75+
76+
> [!IMPORTANT]
77+
> **Please be mindful that anything you say in our community is a matter of public record**.
78+
79+
We publish all conversations in public channels to our [public archive](https://archive.sweetops.com/). We cannot prevent people from taking screenshots or otherwise logging conversations in this slack team.
80+
81+
We also can’t guarantee that every member’s login credentials and logged-in devices are secure and not compromised.
82+
83+
Keep in mind that all files uploaded to this slack team can be viewed and downloaded by anyone both via Slack and our archives.
84+
85+
Please exercise caution and refrain from sharing sensitive information that could harm you or others if it became public.
86+
87+
## Message Retention
88+
89+
Because this is a free slack team, online scrollback is restricted, but Slack (the company) retains a complete log of all channels and direct messages back to the inception of the SweetOps Slack team.
90+
91+
Slack is a U.S. company and therefore subject to subpoenas from U.S. courts. Our logs may be subject to subpoena and could become public as part of legal proceedings.
92+
93+
## Reporting Guidelines
94+
95+
Please let us know if you encounter any unacceptable behavior by sending us an email at [abuse@cloudposse.com](mailto:abuse@cloudposse.com). We would appreciate it if you would include any screenshots that provide a full context of whatever transpired. We might not be able to see what you see, especially if what was sent was in a private direct message.
96+
97+
## Moderation
98+
99+
We perform both automated and human moderation. To some degree, we expect our community to self-moderate and let us know when they see unacceptable behavior.
100+
101+
Moderators reserve the right to delete excessive self-promotional or commercial posts. Similarly, any objectionable, inappropriate or off-topic comments may be deleted. Members posting this content will receive a warning and risk being blocked from the team if the unacceptable behavior persists.
102+
103+
Official moderators of our Slack community are:
104+
- Erik Osterman ([@osterman](https://github.com/osterman))
105+
- Andriy Knysh ([@aknysh](https://github.com/aknysh))
106+
107+
108+
## Enforcement & Consequences
109+
110+
Any unacceptable behavior will not be tolerated.
111+
112+
If you are the subject of or witness to any violations of this Code of Conduct, please email us at [abuse@cloudposse.com](mailto:abuse@cloudposse.com).
113+
114+
If violations occur, our community moderators will take necessary and appropriate actions, up to and including expulsion from the community.
115+
116+
## Membership
117+
118+
Our community is public and free-for-everyone to join. In fact, we encourage you to share our community with everyone you know that might benefit. Our goal is to facilitate collaboration across organizational boundaries so we can achieve SweetOps.
119+
120+
If you would like to invite someone to the team, they may join here:
121+
122+
[https://slack.sweetops.com](/https://slack.sweetops.com/)
123+
124+
## Open Source Collaboration
125+
126+
One of the big goals of our community is to increase the amount of Open Source collaboration in the DevOps community. We hope that by encouraging participants to recognize and strengthen the relationships between companies, organizations and individuals that their effects on our community will be amplified. This is why we go the extra mile to ensure our community is open, welcoming, friendly, and encourages all participants to contribute to the fullest extent possible.
127+
128+
## “Office Hours” Support
129+
130+
Every week we hold public [community “office hours”](https://cloudposse.com/office-hours) which are an opportunity for members to get to know each other face-to-face, ask questions, and get help. These sessions abide by this Code of Conduct.
131+
132+
These sessions may be recorded, published and shared.
133+
134+
## Projects
135+
136+
We support a lot of Open Source projects. These projects abide by this Code of Conduct.
137+
138+
- [https://github.com/cloudposse](https://github.com/cloudposse)
139+
140+
141+
## Contact
142+
143+
We want to hear from you. Please let us know if there’s something we should add, amend or update as part of our Code of Conduct.
144+
145+
| Contact Method | Details |
146+
|---------------------|-------------------------------------------------------------|
147+
| **Email** | [community@cloudposse.com](mailto:community@cloudposse.com) |
148+
| **Phone** | [+1 800-358-9018](tel:+18003589018) |
149+
| **Mailing Address** | 440 N Barranca Ave #1430, Covina, CA 91723 |
150+

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing
2+
3+
First off, thank you for considering contributing to Cloud Posse! It's people like you that make our community great.
4+
5+
## Code of Conduct
6+
7+
Cloud Posse has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
8+
9+
## What Should I Know Before I Get Started?
10+
11+
### Cloud Posse Projects
12+
13+
Each Cloud Posse project is hosted in its own repository on GitHub. Before contributing, familiarize yourself with the specific project you are interested in. Each repository typically contains a [`README.md`](README.md) with an overview of the project, and instructions for setting up your development environment and running tests.
14+
15+
## How Can I Contribute?
16+
17+
### Reporting Bugs
18+
19+
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
20+
21+
Before creating bug reports, please check the Github Issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out issue template as the information it asks for helps us resolve issues faster.
22+
23+
### Suggesting Enhancements
24+
25+
This section guides you through submitting an enhancement suggestion for Cloud Posse, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
26+
27+
### Your First Code Contribution
28+
29+
Unsure where to begin contributing to Cloud Posse? You can start by looking through issues with the following labels:
30+
31+
| Label | Usage |
32+
|:-------------------------------------------------------------------|:--------|
33+
| ![`help-wanted`](https://img.shields.io/badge/help_wanted-388bfd) | issues which should only require a few lines of code, and a test or two. |
34+
| ![`beginner`](https://img.shields.io/badge/beginner-388bfd) | issues which should be a bit more involved than issues. |
35+
36+
### Pull Requests
37+
38+
The process described here has several goals:
39+
40+
- Maintain Cloud Posse's quality
41+
- Fix problems that are important to users
42+
- Engage the community in working toward the best possible Cloud Posse
43+
- Enable a sustainable system for Cloud Posse's maintainers to review contributions
44+
45+
Please follow these steps to have your contribution considered by the maintainers:
46+
47+
1. Follow all instructions in Pull Request template
48+
2. Follow the [styleguides](#styleguides)
49+
3. After you submit your pull request, verify that all status checks are passing
50+
4. If you need to request a review on your PR, please do so in the #pr-reviews Slack channel
51+
52+
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
53+
54+
## Styleguides
55+
56+
### Git Commit Messages
57+
58+
- Use the present tense ("Add feature" not "Added feature")
59+
- Use the imperative mood ("Move resource to..." not "Moves resource to...")
60+
- Limit the first line to 72 characters or less
61+
62+
### Pull Requests
63+
- Reference GitHub Issues and Pull Requests liberally in a `## References` section.
64+
- Use `Closes #1234` to indicate when a PR fixes an issue.

FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: cloudposse

Makefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
export DOCKER_ORG ?= cloudposse
2+
export DOCKER_IMAGE ?= $(DOCKER_ORG)/terraform-root-modules
3+
export DOCKER_TAG ?= latest
4+
export DOCKER_IMAGE_NAME ?= $(DOCKER_IMAGE):$(DOCKER_TAG)
5+
export DOCKER_BUILD_FLAGS =
6+
export README_DEPS ?= docs/targets.md docs/terraform.md
7+
-include $(shell curl -sSL -o .build-harness "https://cloudposse.tools/build-harness"; echo .build-harness)
8+
9+
all: init deps build install run
10+
11+
deps:
12+
@exit 0
13+
14+
build:
15+
@make --no-print-directory docker:build
16+
17+
push:
18+
docker push $(DOCKER_IMAGE)
19+
20+
run:
21+
docker run -it ${DOCKER_IMAGE_NAME} sh

0 commit comments

Comments
 (0)