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

Standardize 'HTTP/2' usage and replace URLs with Markdown links #16189

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

AdeshGhadage
Copy link
Contributor

Description

This is a PR for #16102 . I don't understand what you mean by "URLs to markdown" throughout the reference docs. I have checked the Hugo documentation and found the markdownify function, but when I used it here in HTML, it was not working.

Reviewers

  • Ambient
  • [ X] Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@AdeshGhadage AdeshGhadage requested a review from a team as a code owner January 21, 2025 15:16
@istio-testing istio-testing added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test labels Jan 21, 2025
@istio-testing
Copy link
Contributor

Hi @AdeshGhadage. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@bleggett
Copy link
Contributor

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Jan 21, 2025
Copy link
Contributor

@bleggett bleggett left a comment

Choose a reason for hiding this comment

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

I believe the request is to convert this entire file from .html to .md.

So you will need to rename the file extension and rewrite the contents to use markdown syntax, and not HTML syntax.

See https://github.com/istio/istio.io/tree/a0481a9889636202dbde5b511c0e9ff3a59f3520/content/en/docs/ambient/getting-started/deploy-sample-app for an example index.md

The latter is what our newer docs use, and HTML is later generated from them in an automated step by Hugo.

@AdeshGhadage
Copy link
Contributor Author

@bleggett I will look for any automation or helper I can find. If you know something to help me with, please let me know.

@craigbox
Copy link
Contributor

craigbox commented Jan 24, 2025

Sorry for not being more clear.
What I meant was, there are places where there is a raw URL in the text:

Maximum number of requests that will be queued while waiting for a ready connection pool connection. Default 2^32-1. Refer to https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/circuit_breaking under which conditions a new connection is created for HTTP2. Please note that this is applicable to both HTTP/1.1 and HTTP2.

URLs can't be broken and cause tables to overflow. They should be changed to a Markdown link with an appropriate anchor:

Maximum number of requests that will be queued while waiting for a ready connection pool connection. Default 2^32-1. Refer to Envoy's circuit breaking documentation for under which conditions a new connection is created for HTTP/2. Please note that this is applicable to both HTTP/1.1 and HTTP/2.

(Check Markdown source of this comment if you need)

Do note that these changes need to be made in the istio/api repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants