Skip to content

feat: add Chinese language support for doc site#2532

Merged
zhaohuabing merged 18 commits intoenvoyproxy:mainfrom
wilsonwu:zh-content-init
Mar 26, 2024
Merged

feat: add Chinese language support for doc site#2532
zhaohuabing merged 18 commits intoenvoyproxy:mainfrom
wilsonwu:zh-content-init

Conversation

@wilsonwu
Copy link
Copy Markdown
Contributor

@wilsonwu wilsonwu commented Jan 29, 2024

What type of PR is this?
feat: add Chinese language support for doc site

All local test for compitibility with current English content, by default all contents are English without any URL change.
image
image

After change language, the URL will changed to [domain]/zh/[path] and just translate some of content for example, need more contributter for the translation.
image
image
image

What this PR does / why we need it:
To help Chinese users to learn and use Envoy Gateway easily

Which issue(s) this PR fixes:

Fixes #2012

@wilsonwu wilsonwu requested a review from a team as a code owner January 29, 2024 04:54
@wilsonwu
Copy link
Copy Markdown
Contributor Author

@Xunzhuo please help to review, and let's work on it together!

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.64%. Comparing base (2882b7c) to head (abf2a56).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2532      +/-   ##
==========================================
+ Coverage   64.62%   64.64%   +0.01%     
==========================================
  Files         121      121              
  Lines       21135    21135              
==========================================
+ Hits        13658    13662       +4     
+ Misses       6627     6625       -2     
+ Partials      850      848       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wilsonwu wilsonwu force-pushed the zh-content-init branch 2 times, most recently from d28c63f to 15c4dcf Compare January 29, 2024 08:02
@Xunzhuo
Copy link
Copy Markdown
Member

Xunzhuo commented Feb 23, 2024

Thanks @wilsonwu, let us kick this off after GA.

@Xunzhuo Xunzhuo added the priority/low Label used to express the "low" priority level label Feb 23, 2024
@arkodg arkodg added this to the Backlog milestone Feb 23, 2024
@wilsonwu
Copy link
Copy Markdown
Contributor Author

Congrats the 1.0 GA, let consider the Chinese version doc site, currently no good gateway product doc site support Chinese, I think this is a good opportunity for Envoy Gateway market share.

Copy link
Copy Markdown
Member

@zhaohuabing zhaohuabing left a comment

Choose a reason for hiding this comment

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

This PR looks good! Just a few minor nits :-)

@wilsonwu
Copy link
Copy Markdown
Contributor Author

This PR looks good! Just a few minor nits :-)

Thanks for the review, more i18n contents will coming after this PR done.

@zirain
Copy link
Copy Markdown
Member

zirain commented Mar 15, 2024

I'd like focus on just the latest version, because it's almost WIP.

Copy link
Copy Markdown
Member

@zhaohuabing zhaohuabing left a comment

Choose a reason for hiding this comment

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

@wilsonwu This PR looks good. Could you please remove the v0.0.6 docs as @zirain suggested? Then we can merge it and start the Chinese docs work.

Thansk!

wilsonwu and others added 7 commits March 19, 2024 14:13
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
@wilsonwu
Copy link
Copy Markdown
Contributor Author

@wilsonwu This PR looks good. Could you please remove the v0.0.6 docs as @zirain suggested? Then we can merge it and start the Chinese docs work.

Thansk!

Done, thanks @zhaohuabing and @zirain

zhaohuabing
zhaohuabing previously approved these changes Mar 19, 2024
Copy link
Copy Markdown
Member

@zhaohuabing zhaohuabing left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
@wilsonwu
Copy link
Copy Markdown
Contributor Author

Member

Thanks for reminder, all work fine in local.
image

@zirain zirain added the hold do not merge label Mar 20, 2024
@zirain
Copy link
Copy Markdown
Member

zirain commented Mar 20, 2024

sorry, I want to hold these before we fix all the dead links on the english site.

@wilsonwu
Copy link
Copy Markdown
Contributor Author

sorry, I want to hold these before we fix all the dead links on the english site.

No problem, let me know if I can help on anything.

zhaohuabing
zhaohuabing previously approved these changes Mar 24, 2024
Copy link
Copy Markdown
Member

@zhaohuabing zhaohuabing left a comment

Choose a reason for hiding this comment

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

We can move on now since dead links have been solved.

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
@wilsonwu
Copy link
Copy Markdown
Contributor Author

We can move on now since dead links have been solved.

Thanks for the reminder, fixed a broken link.

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
@wilsonwu
Copy link
Copy Markdown
Contributor Author

There is still one broken link left:
image

And I submitted an issue for it #3005, I think it is not block for this PR.

@zirain zirain removed the hold do not merge label Mar 25, 2024
@zhaohuabing zhaohuabing merged commit 275b5db into envoyproxy:main Mar 26, 2024
yaelSchechter pushed a commit to yaelSchechter/envoy-gateway that referenced this pull request Mar 28, 2024
* Add Chinese support for doc site

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add zh i18n for menus

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add zh content placeholders

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix about zh page

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Apply suggestions from code review

Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* docs: `%s/Application/API/g` (envoyproxy#2929)

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* remove old version for zh content

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Update the latest version link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix default content dir

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Translate landing page and fix broken link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix broken link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add a contribution page

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

---------

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>
arkodg added a commit that referenced this pull request Mar 28, 2024
* build(deps): bump github.com/prometheus/common from 0.50.0 to 0.51.1 (#3010)

Bumps [github.com/prometheus/common](https://github.com/prometheus/common) from 0.50.0 to 0.51.1.
- [Release notes](https://github.com/prometheus/common/releases)
- [Commits](prometheus/common@v0.50.0...v0.51.1)

---
updated-dependencies:
- dependency-name: github.com/prometheus/common
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* docs: fix squash link (#3013)

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* api: support IdleTimeout in clientTrafficPolicy

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* build(deps): bump fortio.org/fortio from 1.63.4 to 1.63.5 (#3011)

Bumps [fortio.org/fortio](https://github.com/fortio/fortio) from 1.63.4 to 1.63.5.
- [Release notes](https://github.com/fortio/fortio/releases)
- [Commits](fortio/fortio@v1.63.4...v1.63.5)

---
updated-dependencies:
- dependency-name: fortio.org/fortio
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* ci: trigger docs action (#3017)

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* ci: fix cherrypick permission (#2985)

Signed-off-by: zirain <zirain2009@gmail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix: set path prefix for http ext auth service (#3018)

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* feat: add Chinese language support for doc site (#2532)

* Add Chinese support for doc site

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add zh i18n for menus

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add zh content placeholders

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix about zh page

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Apply suggestions from code review

Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* docs: `%s/Application/API/g` (#2929)

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* remove old version for zh content

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Update the latest version link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix default content dir

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Translate landing page and fix broken link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Fix broken link

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

* Add a contribution page

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>

---------

Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* feat(translator): implement connection limit (#2952)

* implement connection limit

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix lint

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix lint 2

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix ir, coverage

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix lint 3

Signed-off-by: Guy Daich <guy.daich@sap.com>

* open more connection in e2e

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix error type

Signed-off-by: Guy Daich <guy.daich@sap.com>

* add additional connections

Signed-off-by: Guy Daich <guy.daich@sap.com>

* make limit value required

Signed-off-by: Guy Daich <guy.daich@sap.com>

* add error-flow unit test

Signed-off-by: Guy Daich <guy.daich@sap.com>

* fix lint 4

Signed-off-by: Guy Daich <guy.daich@sap.com>

* assert policy accepted in test

Signed-off-by: Guy Daich <guy.daich@sap.com>

* rename limit => connectionLimit

Signed-off-by: Guy Daich <guy.daich@sap.com>

---------

Signed-off-by: Guy Daich <guy.daich@sap.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* docs: remove 0.1.0  from linkinator ignore list (#3015)

Signed-off-by: yuluo <karashouk.pan@gmail.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* disable connection limit test (#3025)

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix: use correct connection limit attribute name in e2e, docs (#3028)

fix attribute name

Signed-off-by: Guy Daich <guy.daich@sap.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* docs: document patches in envoy proxy (#3027)

* docs: document patches in envoy proxy

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix linting issue

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix pr comment

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

---------

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* feat(policy): Adding BTP support for UDP/TCPRoute (#3004)

* Adding BTP support for UDP/TCP Routes

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

* fixining lint

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

* fix IdleTime check

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

* adding missing generates

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

* fixing code review comments

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

* incresing code coverage

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>

---------

Signed-off-by: Alexander Volchok <alex.volchok@sap.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix: add missing http filters to the http filter chain (#2970)

* fix: add missing http filters to the http filter chain

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* refactor

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* fix lint

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* add comments

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* remove refactor

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* remove refactor

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* fix gen

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

* fix lint

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>

---------

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>
Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix pr comment

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* ci: grant pull-requests permission to cherrypick action (#3039)

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* Update ADOPTERS.md for Airspace Link (#3045)

Signed-off-by: Fabrice Aneche <akhenakh@users.noreply.github.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* feat: added option to specify resources on the OIDC security policy (#3030)

added option to specify resources on the OIDC filter

Signed-off-by: jaynis <kranz.jannis@googlemail.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* run make commands

Signed-off-by: Yael Shechter <yael.shechter@sap.com>

* fix: allow websockets in url rewrite (#3022)

allow websockets in url rewrite

Signed-off-by: Jesse Haka <haka.jesse@gmail.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Yael Shechter <yael.shechter@sap.com>
Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: huabing zhao <zhaohuabing@gmail.com>
Signed-off-by: Wilson Wu <iwilsonwu@gmail.com>
Signed-off-by: Guy Daich <guy.daich@sap.com>
Signed-off-by: yuluo <karashouk.pan@gmail.com>
Signed-off-by: Alexander Volchok <alex.volchok@sap.com>
Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Fabrice Aneche <akhenakh@users.noreply.github.com>
Signed-off-by: jaynis <kranz.jannis@googlemail.com>
Signed-off-by: Jesse Haka <haka.jesse@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Huabing Zhao <zhaohuabing@gmail.com>
Co-authored-by: zirain <zirain2009@gmail.com>
Co-authored-by: Wilson Wu <iwilsonwu@gmail.com>
Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
Co-authored-by: Guy Daich <guy.daich@sap.com>
Co-authored-by: YuLuo <karashouk.pan@gmail.com>
Co-authored-by: Alex Volchok <alex.volchok@sap.com>
Co-authored-by: Fabrice Aneche <akhenakh@users.noreply.github.com>
Co-authored-by: jaynis <kranz.jannis@googlemail.com>
Co-authored-by: Jesse Haka <haka.jesse@gmail.com>
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.

Any plan for Chinese version doc content?

5 participants