docs: formatting updates to api reference #271
Closed
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
|
Fix the PR comment to have just |
|
@ericmariasis please see my comment on your previous PR: #265 (comment) |
|
you don't need to put the unnecessary comment like this 
|
I see, it should now be updated. |
|
Per Slack discussion, I have an action item to look at the make output to fix the style check. I will comment with a follow up when it’s resolved or I have a legitimate blocking issue. |
This comment has been minimized.
This comment has been minimized.
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
…proxy#264) **Commit Message**: Removal of deprecated kubectl command below from [the installation getting started guide](https://github.com/envoyproxy/ai-gateway/blob/main/site/docs/getting-started/installation.md). `kubectl wait --timeout=2m -n envoy-ai-gateway-system deployment/ai-gateway-controller --for=create ` It seems to include a deprecated arg ```--for=create``` **Related Issues/PRs (if applicable)**: Fixes [Issue 262](envoyproxy#262) **Special notes for reviewers (if applicable)**: Signed-off-by: ericmariasis <[email protected]>
**Commit Message** This makes the PR style check stricter than before: * The description's first line must be `**Commit Message**` * The PR title length must be less than 53 characters --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: ericmariasis <[email protected]>
**Commit Message** This refactors the PR style check github workflow. * Renamed the file to match the workflow name. * Split the description checks into multiple runs. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: ericmariasis <[email protected]>
**Commit Message** This follows up on envoyproxy#266 and relaxes the PR title length restriction to 60 characters. It was too strict. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: ericmariasis <[email protected]>
**Commit Message** Added note for Windows users in basic usage that they can use WSL for commands not working on cmd prompt. **Related Issues/PRs (if applicable)** Fixes envoyproxy#263 --------- Signed-off-by: ericmariasis <[email protected]> Co-authored-by: Takeshi Yoneda <[email protected]> Signed-off-by: ericmariasis <[email protected]>
**Commit Message** Apparently, the message was clear enough Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
ericmariasis
force-pushed
the
issue_241
branch
from
a53ab64 to
3329db3
Compare
Signed-off-by: ericmariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]>
|
Cancelled in favor of PR 276. |
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.
Commit Message
This commit makes the resource names larger and more readable as well as some other header fields.
In addition, there is now a "back to top" button at the bottom of the page.
Related Issues/PRs (if applicable)
Fixes issue #241.