Skip to content

DNM Test with reference docs using Goldmark in istio/api #12086

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

DNM Test with reference docs using Goldmark in istio/api #12086

wants to merge 3 commits into from

Conversation

ericvn
Copy link
Contributor

@ericvn ericvn commented Oct 12, 2022

Please provide a description for what this PR is for.

Test deploy using updated tooling to generate with Goldmark instead of BlackFriday (istio/tools#2168).

Ran make gen against istio/api and then updated the docs from my repo's branch.

@ericvn ericvn added the do-not-merge Block automatic merging of a PR. label Oct 12, 2022
@ericvn ericvn requested review from a team as code owners October 12, 2022 15:56
@istio-testing istio-testing added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 12, 2022
@ericvn ericvn mentioned this pull request Oct 12, 2022
Merged
@ericvn
Copy link
Contributor Author

ericvn commented Oct 12, 2022

Need to fix:

Error: Error building site: "/work/content/zh/docs/reference/config/networking/destination-rule/index.html:1:1": unrecognized character in shortcode action: U+0021 '!'. Note: Parameters with non-alphanumeric args must be quoted

found with make serve

@ericvn
Copy link
Contributor Author

ericvn commented Oct 12, 2022

Related to changes like:?

 - <p>{{<tabset category-name="example">}}
 - {{<tab name="v1alpha3" category-value="v1alpha3">}}</p>

 + <p>{{<!-- raw HTML omitted -->}}<br />
 + {{<!-- raw HTML omitted -->}}</p>

@istio-testing istio-testing added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 13, 2022
@ericvn
Copy link
Contributor Author

ericvn commented Oct 13, 2022

Updated the markdown to add Unsafe and remove XHTML and hard breaks. Reran against api and to istio.io.

@istio-testing istio-testing added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 13, 2022
@ericvn
Copy link
Contributor Author

ericvn commented Oct 13, 2022 

var md = goldmark.New(
	goldmark.WithExtensions(extension.GFM),
	goldmark.WithParserOptions(
		parser.WithAutoHeadingID(),
	),
	goldmark.WithRendererOptions(
		html.WithUnsafe(),
	),
)

in md.go yields this. The Deploy looks good. I noticed only one bit of weirdness in formatting, but the actually displayed text is the same. The issue is really that the formatting in istio/api is incorrect in this case and should be fixed.

@ericvn ericvn mentioned this pull request Oct 13, 2022
Merged
@ericvn
Copy link
Contributor Author

ericvn commented Oct 14, 2022

Close this PR as testing is hopefully complete.

@ericvn ericvn closed this Oct 14, 2022
@ericvn ericvn deleted the testNewImage branch November 17, 2022 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
do-not-merge Block automatic merging of a PR. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ericvn @istio-testing