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

Fix zh/2.8 links #1485

Merged
merged 1 commit into from
Sep 19, 2024
Merged

Fix zh/2.8 links #1485

merged 1 commit into from
Sep 19, 2024

Conversation

btat
Copy link
Contributor

@btat btat commented Sep 17, 2024

Description

This PR brings the broken link count from 50 down to 6. The 6 remaining warnings are related to the pages-for-subheader directory, which no longer exists on the English side. When translations were added for the pages-for-subheader/* replacement pages, links to/from other pages (not just pages-for-subheaders/*) were not updated.

A separate PR will be made to remove the pages-for-subheaders directory and handle thenew link warnings that get introduced.

Attached is the before and after output of running yarn run remark --quiet --frail --use remark-validate-links ./i18n/zh/docusaurus-plugin-content-docs/current:

Other Notes

Since the last time i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md had it's translations updated, new English content was added. Other pages of the Chinese content was linking to these new additions, but they didn't exist on the Chinese docs. That content was also copied over as English.

Before

i18n/zh/docusaurus-plugin-content-docs/version-2.8/faq/general-faq.md
19:10-19:87 warning Link to unknown file: (../how-to-guides/new-user-guides/manage-clusters/manage-clusters.md). Did you mean ../how-to-guides/new-user-guides/manage-clusters/manage-clusters.md missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md
76:89-76:187 warning Link to unknown file: ../getting-started/installation-and-upgrade/resources/choose-a-rancher-version.md missing-file remark-validate-links
106:22-106:140 warning Link to unknown file: ../getting-started/installation-and-upgrade/installation-references/helm-chart-options.md missing-file remark-validate-links
106:22-106:140 warning Link to unknown heading in ../getting-started/installation-and-upgrade/installation-references/helm-chart-options.md: 外部-tls-终止 missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md
74:74-74:118 warning Link to unknown file: (https:/rancher.com/contact/) missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/rancher-on-a-single-node-with-docker.md
76:67-76:215 warning Link to unknown file: ../getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md missing-file remark-validate-links
110:73-110:221 warning Link to unknown file: ../getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/advanced-user-guides/enable-api-audit-log.md
33:9-33:38 warning Link to unknown heading: audit-level missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-azure-ad.md
263:48-263:61 warning Link to unknown heading: 3.2 missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md
44:113-44:136 warning Link to unknown heading: cert-command missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-openldap/configure-openldap.md
56:116-56:193 warning Link to unknown heading in ../../../../faq/technical-items.md: how-can-i-enable-debug-logging missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/configure-shibboleth-saml.md
104:116-104:193 warning Link to unknown heading in ../../../../faq/technical-items.md: how-can-i-enable-debug-logging missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md
257:7-257:97 warning Link to unknown heading in ../authentication-config/authentication-config.md: external-vs-local-authentication missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/pod-security-standards.md
23:37-23:70 warning Link to unknown heading: psa-config-templates
missing-heading remark-validate-links
111:53-111:133 warning Link to unknown heading: remove-psp-rancher-workloads
missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md
39:121-39:171 warning Link to unknown file: ../deploy-apps-across-clusters/fleet.md
missing-file remark-validate-links
39:121-39:171 warning Link to unknown heading in ../deploy-apps-across-clusters/fleet.md: 故障排除
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/kubernetes-clusters-in-rancher-setup.md
48:17-48:146 warning Link to unknown heading in ../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md: node-templates
missing-heading-in-file remark-validate-links
52:33-52:162 warning Link to unknown heading in ../launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md: node-drivers
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md
15:24-15:112 warning Link to unknown heading in ../set-up-cloud-providers/amazon.md: using-the-out-of-tree-aws-cloud-provider
missing-heading-in-file remark-validate-links
58:32-58:127 warning Link to unknown heading in ../set-up-cloud-providers/amazon.md: using-the-out-of-tree-aws-cloud-provider
missing-heading-in-file remark-validate-links
152:84-152:167 warning Link to unknown heading in ../set-up-cloud-providers/amazon.md: helm-chart-installation-from-ui
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/kubernetes-resources-setup/kubernetes-resources-setup.md
33:3-33:124 warning Link to unknown heading in load-balancer-and-ingress-controller/layer-4-and-layer-7-load-balancing.md: layer-4-load-balancer#四层负载均衡器
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/nutanix.md
16:3-16:90 warning Link to unknown heading in provision-kubernetes-clusters-in-aos.md: creating-a-nutanix-aos-cluster
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/manage-clusters/manage-clusters.md
19:102-19:246 warning Link to unknown heading in ../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md: cluster-roles
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/integrations-in-rancher/fleet/overview.md
15:21-15:41 warning Link to unknown file: architecture. Did you mean architecture.md
missing-file remark-validate-links
42:33-42:64 warning Link to unknown file: windows-support. Did you mean windows-support.md
missing-file remark-validate-links
50:26-50:68 warning Link to unknown file: use-fleet-behind-a-proxy. Did you mean use-fleet-behind-a-proxy.md
missing-file remark-validate-links
60:70-60:226 warning Link to unknown heading in ../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.md: 1-install-the-rancher-backup-operator. Did you mean 1-安装-rancher-backup-operator missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/integrations-in-rancher/harvester/overview.md
31:30-31:182 warning Link to unknown file: ../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers. Did you mean ../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers.md missing-file remark-validate-links
31:30-31:182 warning Link to unknown heading in ../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/about-provisioning-drivers: 主机驱动 missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/integrations-in-rancher/kubernetes-distributions/kubernetes-distributions.md
16:37-16:164 warning Link to unknown file: ../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup
missing-file remark-validate-links
16:37-16:164 warning Link to unknown heading in ../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup: cluster-management-capabilities-by-cluster-type
missing-heading-in-file remark-validate-links
34:37-34:164 warning Link to unknown file: ../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup
missing-file remark-validate-links
34:37-34:164 warning Link to unknown heading in ../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup: cluster-management-capabilities-by-cluster-type
missing-heading-in-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md
206:21-206:62 warning Link to unknown heading: monitoring-ui-view
missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/pages-for-subheaders/rancher-hardening-guides.md
26:34-26:171 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
27:34-27:170 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
34:61-34:198 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
35:61-35:197 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
43:68-43:203 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
44:68-44:202 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/reference-guides/cluster-configuration/cluster-configuration.md
21:3-21:43 warning Link to unknown file: gke-cluster-configuration.md. Did you mean cluster-configuration.md
missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/reference-guides/cluster-configuration/downstream-cluster-configuration/downstream-cluster-configuration.md
9:8-9:50 warning Link to unknown file: node-template-configuration.md. Did you mean node-template-configuration/azure.md
missing-file remark-validate-links
9:51-9:85 warning Link to unknown file: machine-configuration.md. Did you mean machine-configuration/azure.md
missing-file remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md
185:61-185:98 warning Link to unknown heading: dual-stack-additional-config. Did you mean 额外配置-dual-stack-additional-config
missing-heading remark-validate-links
195:61-195:98 warning Link to unknown heading: dual-stack-additional-config. Did you mean 额外配置-dual-stack-additional-config
missing-heading remark-validate-links

i18n/zh/docusaurus-plugin-content-docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md
20:10-20:53 warning Link to unknown file: use-windows-clusters.md
missing-file remark-validate-links
140:31-140:196 warning Link to unknown heading in ../../../../how-to-guides/new-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md: accessing-clusters-with-kubectl-from-your-workstation missing-heading-in-file remark-validate-links
141:40-141:201 warning Link to unknown heading in ../../../../how-to-guides/new-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md: authenticating-directly-with-a-downstream-cluster missing-heading-in-file remark-validate-links

⚠ 50 warnings
error Command failed with exit code 1.

After

i18n/zh/docusaurus-plugin-content-docs/version-2.8/pages-for-subheaders/rancher-hardening-guides.md
26:34-26:171 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
27:34-27:170 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke1-hardening-guide/rke1-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
34:61-34:198 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
35:61-35:197 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/rke2-hardening-guide/rke2-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
43:68-43:203 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.24.md. Did you mean ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links
44:68-44:202 warning Link to unknown file: ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.7-k8s-v1.25.md. Did you mean ../reference-guides/rancher-security/hardening-guides/k3s-hardening-guide/k3s-self-assessment-guide-with-cis-v1.23-k8s-v1.23.md missing-file remark-validate-links

⚠ 6 warnings
error Command failed with exit code 1.

@btat btat merged commit 9d5db0e into rancher:main Sep 19, 2024
2 checks passed
@btat btat deleted the zh-2.8-links branch September 19, 2024 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant