-
Notifications
You must be signed in to change notification settings - Fork 487
readme updates #157
base: master
Are you sure you want to change the base?
readme updates #157
Conversation
CONTRIBUTING.md
Outdated
1. [Update the code](#update-the-code) | ||
1. [Create a pull request](#create-a-pull-request) | ||
1. [Merge and release](#merge-and-release) | ||
- [Contribution Guidelines](#contribution-guidelines) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this linking to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My editor was automatically forammting and adding this
- [Downtime](#downtime) | ||
- [Create a pull request](#create-a-pull-request) | ||
- [Sign HashiCorp CLA](#sign-hashicorp-cla) | ||
- [Merge and release](#merge-and-release) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These seem to have an extra layer of indentation that isn't necessary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My editor was automatically forammting and adding this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NIT: Looks like the numbers (1.
) were replaced with dashes (-
) unnecessarily.
README.md
Outdated
:category: Service discovery, service mesh | ||
:cloud: aws | ||
:tags: consul, mesh | ||
:license: gruntwork |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
License is open-source
README.md
Outdated
[![Maintained by Gruntwork.io](https://img.shields.io/badge/maintained%20by-gruntwork.io-%235849a6.svg)](https://gruntwork.io/?ref=repo_terraform_aws_consul) | ||
![Terraform Version](https://img.shields.io/badge/tf-%3E%3D0.12.0-blue.svg) | ||
|
||
This repo contains a Module for running Kubernetes clusters on [AWS](https://aws.amazon.com) using [Elastic Kubernetes Service (EKS)](https://docs.aws.amazon.com/eks/latest/userguide/clusters.html) with [Terraform](https://www.terraform.io). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrong description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Modified
README.md
Outdated
* Secure service communication and observe communication between your services without modifying their code. | ||
* Automate load balancer. | ||
* Provides any number of health checks. | ||
* Multi-Data centers out of the box. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace with:
- Deploy Consul servers and agents
- Automatic bootstrapping
- Auto healing
- Auto DNS configuration
- Consul UI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay done
README.md
Outdated
|
||
* [examples folder](https://github.com/hashicorp/terraform-aws-consul/tree/master/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage). | ||
|
||
### Production deployment | ||
|
||
To deploy Consul servers for production using this repo: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move all of this content into core-concepts.md
and link to it from the Core Concepts section. In this Production deployment section, link to the deployment guide: https://learn.hashicorp.com/consul/datacenter-deploy/deployment-guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay done
move consul server and client deployments to core-concepts modify features
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thx!
- [Downtime](#downtime) | ||
- [Create a pull request](#create-a-pull-request) | ||
- [Sign HashiCorp CLA](#sign-hashicorp-cla) | ||
- [Merge and release](#merge-and-release) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NIT: Looks like the numbers (1.
) were replaced with dashes (-
) unnecessarily.
This updates the README to be in line with our new format.