Adding github pages doc using mkdocs #194
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
edgarsilva948
requested review from
nabuskey,
vara-bonthu,
nimakaviani,
candonov,
csantanapr,
7navyasa and
johnphilips3
as code owners
candonov
reviewed
May 31, 2024
docs/getting-started.md
Outdated
|
|
||
| ### terraform | ||
|
|
||
| 1. For consuming Crossplane Blueprints, please see the [Consumption]() section. |
There was a problem hiding this comment.
is there a purpose to having this refer to an empty link?
|
|
||
| 2. To bootstrap using terraform, the typical steps of execution are as follows: | ||
|
|
||
| ```sh |
There was a problem hiding this comment.
should we specify the folder with tf code?
There was a problem hiding this comment.
I meant cd bootstrap/terraform in this section before the terraform init.
docs/getting-started.md
Outdated
| on your local machine and allow you to interact with your EKS Cluster using `kubectl`. | ||
|
|
||
| ```sh | ||
| aws eks --region <REGION> update-kubeconfig --name <CLUSTER_NAME> |
There was a problem hiding this comment.
Suggested change
| aws eks --region <REGION> update-kubeconfig --name <CLUSTER_NAME> | |
| aws eks --region <REGION> update-kubeconfig --name <CLUSTER_NAME> --alias <CLUSTER_NAME> |
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?
implements the github pages documentation using mkdocs as suggested here #11 and also documents the destroy process to fix this #167 .
Motivation
#11
More
Note:
For Moderators
Additional Notes
N/A