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: update the networking folder for the zh-docs #10717

Closed
wants to merge 1 commit into from

Conversation

saltbo
Copy link
Member

@saltbo saltbo commented Jan 4, 2022

No description provided.

@saltbo saltbo requested a review from a team as a code owner January 4, 2022 10:48
@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been awhile since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, about our style guidelines,
    and about all the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be
    built as a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the Status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point
    to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    status section of the page. Click on the Details link to get a list of the problems with your PR.
    Fix those problems and push an update to your PR. This will automatically rerun the tests and
    hopefully this time everything will be perfect.

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. needs-ok-to-test labels Jan 4, 2022
@istio-testing
Copy link
Contributor

Hi @saltbo. 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/test-infra repository.

@saltbo saltbo force-pushed the docs_refrence_networking branch from 54333bb to 10a48c0 Compare January 4, 2022 10:52
@zirain
Copy link
Member

zirain commented Jan 4, 2022

@saltbo are you still WIP? IMHO, we should not copy en doc to zh folder.

Copy link
Member

@Arhell Arhell 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-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 4, 2022
@saltbo
Copy link
Member Author

saltbo commented Jan 4, 2022

@saltbo are you still WIP? IMHO, we should not copy en doc to zh folder.

I see that the en docs are automatically generated, and the previous zh docs are not translated.

What is the correct posture? @zirain

@ericvn ericvn added the translation/chinese Translation item label Jan 4, 2022
@zirain
Copy link
Member

zirain commented Jan 4, 2022

@saltbo are you still WIP? IMHO, we should not copy en doc to zh folder.

I see that the en docs are automatically generated, and the previous zh docs are not translated.

What is the correct posture? @zirain

AFAIK, reference docs are generated from istio/api repo, @ericvn can you share more details about it?

@istio-testing
Copy link
Contributor

@saltbo: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
lint_istio.io 10a48c0 link true /test lint_istio.io
doc.test.profile_default_istio.io 10a48c0 link true /test doc.test.profile_default_istio.io

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/test-infra repository. I understand the commands that are listed here.

@ericvn
Copy link
Contributor

ericvn commented Jan 4, 2022

@zirain You are correct in that there is a nightly job which updates various reference documents based on thing in other repos. The job runs make update_ref_docs which calls the scripts/grab_reference_docs.sh script. If you look at the script, it only updates the en directory, leaving the other language directories alone. I suspect the reason is that an updated reference docs could point to new istio.io documentation (see Note below), and if the translation hasn't been updated on that istio.io page, the linter could fail with a bad link.

Ignoring that issue, another question would be if these reference files should/could contain translated text? If they could include translations, then we would not want to replace them every time. If they should remain the same across translations, then I think we could upgrade the script to update them all in each language. I'm curious what @craigbox and the translation teams think. Should these files have translations, or should the be consistent across languages?

Note: If we update the script, we probably need to tweak the links that the reference docs point to (see the lint errors):

Ensure translated content doesn't include references to English content

@ericvn
Copy link
Contributor

ericvn commented Jan 4, 2022

I am doing a quick test in #10719 to see what might happen if we tried to updating the /zh/ version of the reference files using the tooling. It looks like we would have to do some more updates for some issues I noted there.

@ericvn
Copy link
Contributor

ericvn commented Jan 6, 2022

@craigbox Any thoughts on if we should update the reference docs in the zh tree? Do we just do it manually as I did in #10719 or do we let the translation team move them as they see fit?

@ericvn
Copy link
Contributor

ericvn commented Jan 21, 2022

No response on whether we should update the reference docs in the /zh/ tree so closing my test PR for now. If we want to update all the reference docs, we can recreate the PR, as there have been updates since that PR was done.

@ericvn
Copy link
Contributor

ericvn commented May 2, 2022

#11252 updates the reference docs in the zh folder.

@istio-testing istio-testing added the needs-rebase Indicates a PR needs to be rebased before being merged label May 10, 2022
@istio-testing
Copy link
Contributor

@saltbo: PR needs rebase.

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/test-infra repository.

@saltbo saltbo closed this Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-rebase Indicates a PR needs to be rebased before being merged ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. translation/chinese Translation item
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants