Skip to content

Commit

Permalink
Populated README, issue templates, updated CRD examples
Browse files Browse the repository at this point in the history
  • Loading branch information
micahhausler committed Dec 1, 2020
1 parent b94f3b3 commit ec62162
Show file tree
Hide file tree
Showing 6 changed files with 510 additions and 197 deletions.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Bug Report
about: Report a bug encountered using the EKS Distro

---

<!-- Please use this template while reporting a bug and provide as much info as possible. Please also search for existing open and closed issues that may answer your question. Thanks!-->

**What happened**:

**What you expected to happen**:

**How to reproduce it (as minimally and precisely as possible)**:

**Anything else we need to know?**:

**Environment**:
- EKS Distro Release Channel:
- EKS Distro Release:

<!-- If this is a security issue, please do not discuss on GitHub. Please report any suspected or confirmed security issues to AWS Security https://aws.amazon.com/security/vulnerability-reporting/ -->
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Feature Request
about: Suggest a feature

---
<!-- Please only use this template for feature requests. Please also search for existing open and closed issues that may answer your question. Thanks!-->

**What would you like to be added**:

**Why is this needed**:

<!-- If this is a security issue, please do not discuss on GitHub. Please report any suspected or confirmed security issues to AWS Security https://aws.amazon.com/security/vulnerability-reporting/ -->
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*Issue #, if available:*

*Description of changes:*


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

<!-- If this is a security issue, please do not discuss on GitHub. Please report any suspected or confirmed security issues to AWS Security https://aws.amazon.com/security/vulnerability-reporting/ -->
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,42 @@

[![Build status](https://prow.eks.amazonaws.com/badge.svg?jobs=*-base-postsubmit)](https://prow.eks.amazonaws.com/?type=postsubmit)

TODO: Fill this README out!
This repository contains tooling used to build the [EKS
Distro](https://distro.eks.amazonaws.com), and all the projects contained in
https://github.com/aws/eks-distro.

Be sure to:
### builder-base

* Change the title in this README
* Edit your repository description on GitHub
bulider-base contains a Dockerfile and install scripting for building a
container image used to run [prow
jobs](https://github.com/aws/eks-distro-prow-jobs) in our [prow
cluster](https://prow.eks.amazonaws.com).

### eks-distro-base

eks-distro-base contains a Dockerfile used to build an up-to-date Amazon Linux 2
base image. This base will be updated whenever there are any security updates to
RPMs contained in the base image.

### helm-charts

The helm-charts directory contains [Helm](https://helm.sh) charts used to
operate Prow and supporting tooling on the Prow EKS clusters. These charts are
not considered stable for external use.

### release

The release directory contains release tooling and build code for generating EKS
Distro release CRDs.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
If you discover a potential security issue in this project, or think you may
have discovered a security issue, we ask that you notify AWS Security via our
[vulnerability reporting
page](http://aws.amazon.com/security/vulnerability-reporting/). Please do
**not** create a public GitHub issue.

## License

This project is licensed under the Apache-2.0 License.

Loading

0 comments on commit ec62162

Please sign in to comment.