fix formatting issues in deploy.md #726
Merged
Conversation
This file contains hidden or 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
github-merge-queue bot removed this pull request from the merge queue due to failed status checks github-merge-queue bot removed this pull request from the merge queue due to failed status checks github-merge-queue bot pushed a commit that referenced this pull request May 7, 2025
* fix formatting issues in deploy.md * fix formatting issues in deploy.md --------- Co-authored-by: Ryan Lymburner <137918933+rlymbur@users.noreply.github.com>
github-merge-queue bot removed this pull request from the merge queue due to failed status checks github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Which issue does this PR fix:
N/A
What does this PR do / Why do we need it:
This pull request includes several updates to the deployment guide for the AWS Gateway API Controller. The changes focus on improving clarity, fixing formatting issues, and ensuring consistency in the documentation.
Documentation improvements:
docs/guides/deploy.md: Improved sentence structure and clarity in the introductory section and various instructions. [1] [2]docs/guides/deploy.md: Corrected the formatting of lists and commands, ensuring consistent use of punctuation and code blocks. [1] [2] [3] [4]docs/guides/deploy.md: Added missing steps and details in the IAM permissions and Pod Identities setup sections to provide a more comprehensive guide. [1] [2]If an issue # is not available please add repro steps and logs from aws-gateway-controller showing the issue:
Testing done on this change:
Yes
Automation added to e2e:
Will this PR introduce any new dependencies?:
Will this break upgrades or downgrades. Has updating a running cluster been tested?:
No
Does this PR introduce any user-facing change?:
Yes
Do all end-to-end tests successfully pass when running
make e2e-test?:N?A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.