Doc updates for README and Getting Started guide #413
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
askulkarni2
reviewed
Apr 13, 2022
README.md
Outdated
| managed_node_groups = { | ||
| mg_m4l = { | ||
| node_group_name = "managed-ondemand" | ||
| instance_types = ["m4.large"] |
There was a problem hiding this comment.
Lets use m5 instances as they are the latest.
README.md
Outdated
| module "eks-blueprints" { | ||
| source = "github.com/aws-ia/terraform-aws-eks-blueprints" | ||
| module "eks_blueprints" { | ||
| source = "github.com/aws-ia/terraform-aws-eks-blueprints" |
There was a problem hiding this comment.
Now now. We can do this when we register our module with Terraform Registry. We can simply introduce a version variable to docs and examples
README.md
Outdated
|
|
||
| depends_on = [module.eks-blueprints.managed_node_groups] | ||
| module "eks_blueprints_kubernetes_addons" { | ||
| source = "github.com/aws-ia/terraform-aws-eks-blueprints//modules/kubernetes-addons" |
There was a problem hiding this comment.
same as my above comment
| ```shell script | ||
| terraform apply | ||
| ``` | ||
| terraform apply -target="module.aws_vpc" |
vara-bonthu
reviewed
Apr 14, 2022
docs/add-ons/index.md
Outdated
| @@ -49,40 +49,42 @@ In order to deploy an add-on with default configuration, simply enable the add-o | |||
|
|
|||
| ```hcl | |||
| module "eks-blueprints-kubernetes-addons" { | |||
There was a problem hiding this comment.
we can change the module names to use underscore (_) instead of hyphen (-) as a best practise and be consistent with TF standards. This might need changing in many other places as well
docs/core-concepts.md
Outdated
|
|
||
| See our [`Teams`](./teams) documentation page for detailed information. | ||
|
|
||
| ## Application | ||
|
|
||
| `Applications` represent the actual workloads that run within a Kubernetes cluster. The framework leverages a GitOps approach for deploying applications onto clusters. | ||
|
|
||
| See our [`Applications](https://github.com/aws-ia/terraform-aws-eks-blueprints/blob/main/docs/add-ons/argocd.md#boostrapping) documentation for detailed information. | ||
| See our [`Applications](./add-ons/argocd.md#boostrapping) documentation for detailed information. |
There was a problem hiding this comment.
We can keep this as full link to github pages. See my comments above
bryantbiggs
reviewed
Apr 14, 2022
Updating doc paths Co-authored-by: Bryant Biggs <bryantbiggs@gmail.com> Co-authored-by: Vara Bonthu <vara.bonthu@gmail.com>
kcoleman731
force-pushed
the
feature/doc-updates-readme-getting-started
branch
from
c05728e
to
7314c13
Compare
kcoleman731
force-pushed
the
feature/doc-updates-readme-getting-started
branch
from
686305b
to
a86264f
Compare
bryantbiggs
approved these changes
Apr 18, 2022
vara-bonthu
approved these changes
Apr 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Documentation updates. Readme, getting started guide, and a few other doc pages.
Motivation
More
pre-commit run -awith this PRNote: Not all the PRs required examples and docs except a new pattern or add-on added.
For Moderators
Additional Notes