Skip to content

Commit fa3f6ab

Browse files
authored
small updates for outcomes, docs, and roadmap (#68)
* small updates for outcomes and docs * updated roadmap for recent merges * cleaned up readme(s) and content * formatted workshop with prettier
1 parent 62c7c14 commit fa3f6ab

File tree

18 files changed

+132
-107
lines changed

18 files changed

+132
-107
lines changed

Diff for: CODE_OF_CONDUCT.md

+21-12
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
# Contributor Covenant Code of Conduct
22

33
## Our Pledge
4+
45
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.
56

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

89
## Our Standards
10+
911
Examples of behavior that contributes to a positive environment for our community include:
1012

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

1719
Examples of unacceptable behavior include:
1820

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

2527
## Enforcement Responsibilities
28+
2629
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.
2730

2831
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.
@@ -32,31 +35,37 @@ Community leaders have the right and responsibility to remove, edit, or reject c
3235
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.
3336

3437
## Enforcement
38+
3539
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for monitoring and enforcement at [email protected] or [email protected].
3640

3741
All complaints will be reviewed and investigated promptly and fairly.
3842

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

4145
## Enforcement Guidelines
46+
4247
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct as stated below:
4348

4449
### 1. Correction
50+
4551
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
4652

4753
**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.
4854

4955
### 2. Warning
56+
5057
**Community Impact**: A violation through a single incident or series of actions.
5158

5259
**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.
5360

5461
### 3. Temporary Ban
62+
5563
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
5664

5765
**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.
5866

5967
### 4. Permanent Ban
60-
**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.
6168

62-
**Consequence**: A permanent ban from any sort of public interaction within the community.
69+
**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.
70+
71+
**Consequence**: A permanent ban from any sort of public interaction within the community.

Diff for: CONTRIBUTING.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
# Contributing Guidelines
2+
23
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
34

45
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
56

67
## Reporting Bugs/Feature Requests
8+
79
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
810

911
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
10-
* A reproducible test case or series of steps
11-
* The version of our code being used
12-
* Any modifications you've made relevant to the bug
13-
* Anything unusual about your environment or deployment
12+
13+
- A reproducible test case or series of steps
14+
- The version of our code being used
15+
- Any modifications you've made relevant to the bug
16+
- Anything unusual about your environment or deployment
1417

1518
## Contributing via Pull Requests
19+
1620
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
1721

18-
1. You are working against the latest source on the *main* branch.
22+
1. You are working against the latest source on the _main_ branch.
1923
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2024
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
2125

@@ -32,14 +36,18 @@ GitHub provides additional document on [forking a repository](https://help.githu
3236
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
3337

3438
## Finding Contributions to Work On
39+
3540
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
3641

3742
## Code of Conduct
43+
3844
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
3945
[email protected] with any additional questions or comments. If you have any Rancher specific questions or comments, please out to [email protected].
4046

4147
## Security Issue Notifications
48+
4249
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
4350

4451
## Licensing
45-
See the [LICENSE](/LICENSE.md) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
52+
53+
See the [LICENSE](/LICENSE.md) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Diff for: LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
66

77
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
88

9-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: README.md

+32-28
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
---
2-
title: "Welcome to Rancher on AWS"
2+
title: 'Welcome to Rancher on AWS'
33
---
44

55
![rgs-aws-banner](/static/images/rgs-aws-banner.png)
66

77
# Welcome to the Rancher on AWS Workshop
8+
89
Learn how to easily deploy and manage Kubernetes with Rancher on the AWS Cloud!
910

1011
**Created together by [Rancher Government Solutions](https://ranchergovernment.com) and [Amazon Web Services](https://aws.amazon.com) under the MIT-0 and CC-BY-4.0 Licenses.**
1112

12-
This repository has the source code for the workshop content and environment. To get started with the **Rancher on AWS Workshop**, please head to the
13-
workshop content in the **[AWS Workshop Studio](https://catalog.us-east-1.prod.workshops.aws/workshops/be7b2281-57e8-44d0-a40e-1b7ea0d88f2a)!**
13+
This repository has the source code for the workshop content and environment. To get started with the **Rancher on AWS Workshop**, please head to the
14+
interactive workshop in the **[AWS Workshop Studio](https://catalog.workshops.aws/rancher)!**
1415

1516
## Requirements
16-
* Basic Knowledge of Kubernetes and AWS Infrastructure.
17-
* AWS Account - If you don't have one, it's easy and free to [create one now](https://aws.amazon.com/)!
18-
* AWS Account with the ability to deploy into *us-east-1*.
19-
* AWS Account IAM Role with *elevated privileges* to interact with AWS Services.
20-
* AWS Service Quota with at least 1 VPC, 56 vCPUs, 220 GiB Memory, and 1750 Gi of Storage.
17+
18+
- Basic Knowledge of Kubernetes and AWS Infrastructure.
19+
- AWS Account - If you don't have one, it's easy and free to [create one now](https://aws.amazon.com/)!
20+
- AWS Account with the ability to deploy into _us-east-1_.
21+
- AWS Account IAM Role with _elevated privileges_ to interact with AWS Services.
22+
- AWS Service Quota with at least 1 VPC, 56 vCPUs, 220 GiB Memory, and 1750 Gi of Storage.
2123

2224
## Table of Contents
23-
* [Introduction](/content/10-introduction/index.en.md)
24-
* [Workshop Overview](/content/10-introduction/11-workshop-overview/index.en.md)
25-
* [Workshop Environment](/content/10-introduction/12-workshop-environment/index.en.md)
26-
* [Documentation](/content/10-introduction/13-documentation/index.en.md)
27-
* [Exploring the Cluster](/content/20-exploring-the-cluster/index.en.md)
28-
* [Exploring the Cluster](/content/20-exploring-the-cluster/21-exploring-the-cluster/index.en.md)
29-
* [Rancher Applications](/content/20-exploring-the-cluster/22-rancher-applications/index.en.md)
30-
* [Kubernetes Applications](/content/20-exploring-the-cluster/23-kubernetes-applications/index.en.md)
31-
* [Creating a Cluster](/content/30-creating-a-cluster/index.en.md)
32-
* [Creating the EKS Cluster](/content/30-creating-a-cluster/31-creating-eks-cluster/index.en.md)
33-
* [Creating the RKE2 Cluster](/content/30-creating-a-cluster/32-creating-rke2-cluster/index.en.md)
34-
* [Importing a Cluster](/content/40-importing-a-cluster/index.en.md)
35-
* [Importing the Cluster](/content/40-importing-a-cluster/41-importing-the-cluster/index.en.md)
36-
* [Additional AWS Integrations](/content/50-additional-integrations/index.en.md)
37-
* [Workshop Conclusion](/content/60-conclusion/index.en.md)
38-
39-
**Please Note:**
40-
* [/assets/](/assets/) stores the static code and resources for the workshop environment.
41-
* [/content/](/content/) stores all the content and instructions for the workshop.
42-
* [/static/](/static/) stores all the static code and resources.
25+
26+
- [Introduction](/content/10-introduction/index.en.md)
27+
- [Workshop Overview](/content/10-introduction/11-workshop-overview/index.en.md)
28+
- [Workshop Environment](/content/10-introduction/12-workshop-environment/index.en.md)
29+
- [Documentation](/content/10-introduction/13-documentation/index.en.md)
30+
- [Exploring the Cluster](/content/20-exploring-the-cluster/index.en.md)
31+
- [Exploring the Cluster](/content/20-exploring-the-cluster/21-exploring-the-cluster/index.en.md)
32+
- [Rancher Applications](/content/20-exploring-the-cluster/22-rancher-applications/index.en.md)
33+
- [Kubernetes Applications](/content/20-exploring-the-cluster/23-kubernetes-applications/index.en.md)
34+
- [Creating a Cluster](/content/30-creating-a-cluster/index.en.md)
35+
- [Creating the EKS Cluster](/content/30-creating-a-cluster/31-creating-eks-cluster/index.en.md)
36+
- [Creating the RKE2 Cluster](/content/30-creating-a-cluster/32-creating-rke2-cluster/index.en.md)
37+
- [Importing a Cluster](/content/40-importing-a-cluster/index.en.md)
38+
- [Importing the Cluster](/content/40-importing-a-cluster/41-importing-the-cluster/index.en.md)
39+
- [Additional AWS Integrations](/content/50-additional-integrations/index.en.md)
40+
- [Workshop Conclusion](/content/60-conclusion/index.en.md)
41+
42+
### Repository Structure
43+
44+
- [/assets/](/assets/) stores the static code, assets, and resources for the workshop environment.
45+
- [/content/](/content/) stores all the content and instructions for the workshop.
46+
- [/static/](/static/) stores all the static code, assets, and resources.

0 commit comments

Comments
 (0)