Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix code block indentation #223

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Conversation

davidxia
Copy link
Contributor

@davidxia davidxia commented Jan 29, 2025

Commit Message:

Block should be indented.

Some unrelated minor Markdown formatting improvements like using auto-incrementing lists and removing unnecessary colons.

@davidxia davidxia requested a review from a team as a code owner January 29, 2025 21:21
@davidxia
Copy link
Contributor Author

Currently looks like this. Notice the unindented block.

image

Are these docs generated and hosted anywhere?

@mathetake
Copy link
Member

you can check the preview website from here and i see there are still few places indent is not consistent.. would you mind fixing the rest of the blocks?
image

@mathetake
Copy link
Member

main branch is currently hosted at https://envoy-ai-gateway.netlify.app/ and will be hosted at aigateway.envoyproxy.io fwiw

@davidxia davidxia force-pushed the patch-1 branch 2 times, most recently from 41149ed to ba01803 Compare January 29, 2025 22:19
@mathetake
Copy link
Member

could you fix the PR title? then good to go

@missBerg
Copy link
Contributor

@mathetake let me check, the preview - seems we may be getting some odd edits

@missBerg
Copy link
Contributor

I don't necessarily a fan of the auto incrementing lists, I understand the benefits, but not a merge blocker.

@missBerg missBerg changed the title fix docs: fix code block indentation docs: fix code block indentation Jan 29, 2025
@missBerg
Copy link
Contributor

I updated the title to match the required format

@missBerg missBerg added the documentation Improvements or additions to documentation label Jan 29, 2025
@missBerg missBerg enabled auto-merge (squash) January 29, 2025 22:40
Copy link
Contributor

@missBerg missBerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok to merge

site/docs/getting-started/connect-providers/index.md Outdated Show resolved Hide resolved
site/docs/getting-started/connect-providers/index.md Outdated Show resolved Hide resolved
site/docs/getting-started/connect-providers/openai.md Outdated Show resolved Hide resolved
site/docs/getting-started/connect-providers/openai.md Outdated Show resolved Hide resolved
auto-merge was automatically disabled January 30, 2025 15:37

Head branch was pushed to by a user without write access

Comment on lines +34 to +38
3. Download configuration template

```shell
curl -O https://raw.githubusercontent.com/envoyproxy/ai-gateway/main/examples/basic/basic.yaml
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the important change

Comment on lines +91 to +93

```shell
kubectl logs services/ai-eg-route-extproc-envoy-ai-gateway-basic
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the important change

Block should be indented.

Some unrelated minor Markdown formatting improvements
like using auto-incrementing lists and removing unnecessary colons.

Signed-off-by: David Xia <[email protected]>
@davidxia
Copy link
Contributor Author

Thanks for reviewing. I think I addressed all the comments.

@mathetake mathetake merged commit 2543efa into envoyproxy:main Jan 30, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants