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(zh-cn): update clusters intro contents and hide interactive page in TOC #48713

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mo3et
Copy link

@mo3et mo3et commented Nov 13, 2024

Description

update clusters-intro contents in tutorials/kubernetes-basics && hide tutorials/kubernetes-basics interactive page in TOC

This PR solves the issue of hiding certain interactive pages in the TOC and aligning the filenames with the English documentation. Such as tutorials/kubernetes-basics/explore/explore-interactive and tutorials/kubernetes-basics/update/update-interactive.

I saw in the previous comment message that you seemed to use the term remove katacoda tutorials.

At the same time, I’ve also updated the tutorials/kubernetes-basics/create-cluster/cluster-intro.html section and made some of the content more human-friendly.

Running the script produced this output

k8s-website on  main via 🐳 orbstack via 🐹 v1.23.2 via  v22.9.0 
➜ ./scripts/lsync.sh content/zh-cn/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html

content/zh-cn/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html is still in sync

Issue

Closes: #

@k8s-ci-robot k8s-ci-robot added the area/localization General issues or PRs related to localization label Nov 13, 2024
Copy link

linux-foundation-easycla bot commented Nov 13, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: mo3et / name: Monet Lee (1aef5e4)

@k8s-ci-robot k8s-ci-robot added language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 13, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @mo3et!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 13, 2024
Copy link

netlify bot commented Nov 13, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 1aef5e4
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67378d53859f4800081a4a6b
😎 Deploy Preview https://deploy-preview-48713--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mo3et mo3et changed the title docs(zh-cn): update clusters intro contents and move docs to interactive docs(zh-cn): update clusters intro contents and hide interactive page in toc Nov 13, 2024
@mo3et mo3et changed the title docs(zh-cn): update clusters intro contents and hide interactive page in toc docs(zh-cn): update clusters intro contents and hide interactive page in TOC Nov 13, 2024
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 13, 2024
@windsonsea
Copy link
Member

windsonsea commented Nov 14, 2024

Please provide some useful description for your PR. Tell reviewers why this PR comes. If adding some links to the upstream PR will be more helpful.

Also, you need to check all the in-synced content with the english upstream one by one.
For example, run this command on your local main branch:

./scripts/lsync.sh content/zh-cn/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
diff --git a/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html b/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
index 122ed7346e..5a5c77b78a 100644
--- a/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
+++ b/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
@@ -74,7 +74,7 @@ description: |-
         <div class="row">
             <div class="col-md-8">
                 <p><b>The Control Plane is responsible for managing the cluster.</b> The Control Plane coordinates all activities in your cluster, such as scheduling applications, maintaining applications' desired state, scaling applications, and rolling out new updates.</p>
-                <p><b>A node is a VM or a physical computer that serves as a worker machine in a Kubernetes cluster.</b> Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes control plane. The node should also have tools for handling container operations, such as containerd or Docker. A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an <a href="/docs/concepts/overview/components/#etcd">etcd</a> member and a control plane instance are lost, and redundancy is compromised. You can mitigate this risk by adding more control plane nodes.</p>
+                <p><b>A node is a VM or a physical computer that serves as a worker machine in a Kubernetes cluster.</b> Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes control plane. The node should also have tools for handling container operations, such as {{< glossary_tooltip text="containerd" term_id="containerd" >}} or {{< glossary_tooltip term_id="cri-o" >}}. A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an <a href="/docs/concepts/architecture/#etcd">etcd</a> member and a control plane instance are lost, and redundancy is compromised. You can mitigate this risk by adding more control plane nodes.</p>

@mo3et
Copy link
Author

mo3et commented Nov 14, 2024

Please provide some useful description for your PR. Tell reviewers why this PR comes. If adding some links to the upstream PR will be more helpful.

Also, you need to check all the in-synced content with the english upstream one by one. For example, run this command on your local main branch:

./scripts/lsync.sh content/zh-cn/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
diff --git a/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html b/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
index 122ed7346e..5a5c77b78a 100644
--- a/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
+++ b/content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html
@@ -74,7 +74,7 @@ description: |-
         <div class="row">
             <div class="col-md-8">
                 <p><b>The Control Plane is responsible for managing the cluster.</b> The Control Plane coordinates all activities in your cluster, such as scheduling applications, maintaining applications' desired state, scaling applications, and rolling out new updates.</p>
-                <p><b>A node is a VM or a physical computer that serves as a worker machine in a Kubernetes cluster.</b> Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes control plane. The node should also have tools for handling container operations, such as containerd or Docker. A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an <a href="/docs/concepts/overview/components/#etcd">etcd</a> member and a control plane instance are lost, and redundancy is compromised. You can mitigate this risk by adding more control plane nodes.</p>
+                <p><b>A node is a VM or a physical computer that serves as a worker machine in a Kubernetes cluster.</b> Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes control plane. The node should also have tools for handling container operations, such as {{< glossary_tooltip text="containerd" term_id="containerd" >}} or {{< glossary_tooltip term_id="cri-o" >}}. A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an <a href="/docs/concepts/architecture/#etcd">etcd</a> member and a control plane instance are lost, and redundancy is compromised. You can mitigate this risk by adding more control plane nodes.</p>

Thanks for your feedback. Now I update description in comment, and execute the script it is not problems.

@windsonsea
Copy link
Member

Please squash your commits into a single one, thanks.

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language language/pt Issues or PRs related to Portuguese language size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 15, 2024
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Nov 15, 2024
@mo3et mo3et changed the title docs(zh-cn): update clusters intro contents and hide interactive page in TOC [WIP]docs(zh-cn): update clusters intro contents and hide interactive page in TOC Nov 15, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2024
@mo3et
Copy link
Author

mo3et commented Nov 15, 2024

Please squash your commits into a single one, thanks.

I have a question. If i squash into a single, is use merge or squash merge when bot merge it.

My branch is dirty when i wrong operation. I worry to my PR will dirty the main branch. So I need to solve it to night.

I also to know, If I pulled the upstream branch during some of my commit submissions, do I need to pick them when squashing?

@windsonsea

@windsonsea
Copy link
Member

If possible, you can separate those changes into different PR. This is your first PR. A tiny change is acceptable.

@mo3et
Copy link
Author

mo3et commented Nov 15, 2024

If possible, you can separate those changes into different PR. This is your first PR. A tiny change is acceptable.

OK. If possible, I would prefer not to break it down into too many small parts, as this might put unnecessary pressure on the reviewers.
Thank you for your patient response 😃

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chenrui333 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 15, 2024
… in TOC

docs[zh-cn]: move docs to interactive-gone in tutorial kubernetes-basics

docs[zh-cn]: update cluster-intro contents in tutorials kubernetes-basics

docs(zh-cn): hide interactive page in toc.

fix: revert uncorrect change.
@mo3et mo3et changed the title [WIP]docs(zh-cn): update clusters intro contents and hide interactive page in TOC docs(zh-cn): update clusters intro contents and hide interactive page in TOC Nov 15, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2024
@mo3et
Copy link
Author

mo3et commented Nov 15, 2024

If possible, you can separate those changes into different PR. This is your first PR. A tiny change is acceptable.

Fortunately, I found a clean, unpulled upstream branch on my Fedora system, and I have resolved the issue.
Thank you for your support over the past few days. QAQ

But I made a mistake, and the bot incorrectly added some other language labels. (like language/pt and language/en ) I think I don't have the permission to remove them. Need you help me remove it.
@windsonsea

@tengqm
Copy link
Contributor

tengqm commented Nov 16, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7bd5b1726c55c10e12539fcec977a0387b255e34

@dipesh-rawat
Copy link
Member

/remove-language pt en

@k8s-ci-robot k8s-ci-robot removed language/pt Issues or PRs related to Portuguese language language/en Issues or PRs related to English language labels Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/localization General issues or PRs related to localization cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/zh Issues or PRs related to Chinese language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. 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