Incomplete translations of Chinese documentation

zhihali commented 1 month ago

Issue Description

There are two main issues with the non-English documentation for OpenTelemetry:

Edit (@chalin): this will be tracked via #4898 ~Broken links in Chinese, Japanese, and Portuguese documentation:~
- ~In these language versions, clicking on "API" or "Examples" under "Language APIs & SDKs/Python" leads to a "not found" page; for example, under chinese page it if you click API, it will jump to https://opentelemetry.io/zh/docs/languages/python/api/~
- The correct links should be:
  - API: https://opentelemetry-python.readthedocs.io/en/stable/api/index.html
  - Examples: https://opentelemetry-python.readthedocs.io/en/stable/examples/
Incomplete translations:
- The Chinese documentation appears to have limited translations, with much of the content still in English.

Proposed Solutions

Fix the broken links in the Chinese, Japanese, and Portuguese documentation to point to the correct API and Examples pages. I can try to do this.
Consider expanding translation efforts for non-English documentation, particularly for Chinese. As a community member, I'm willing to contribute translations for Python and Go documentation if there's a need.

Questions for Consideration

Is there significant demand for fully translated documentation in languages like Chinese?
Are there metrics available on the views/usage of non-English documentation pages?
Should translation efforts be prioritized, or deferred based on current demand and resources?

I'm open to contributing to this effort if the community feels it would be valuable.

chalin commented 1 month ago

Thanks for reporting issue (1) @zhihali. I'll be addressing it after the following PR is merged:

4895

As for (2), that holds true of all non English localizations and is understood to be true :). Your contributions are welcome. Submit a PR. You asked good questions. Here are some analytics for zh page views:

Path	Views
/zh/docs/what-is-opentelemetry/	1337
/zh/	1076
/zh/docs/getting-started/dev/	856
/zh/docs/	593
/zh/docs/getting-started/	567
/zh/docs/demo/	480
/zh/docs/getting-started/ops/	459
/zh/docs/concepts/observability-primer/	391
/zh/docs/concepts/	321
/zh/docs/concepts/context-propagation/	296
/zh/docs/demo/architecture/	260
/zh/docs/collector/quick-start/	248
/zh/docs/concepts/signals/traces/	242
/zh/docs/languages/java/	227
/zh/docs/collector/	220
/zh/docs/collector/installation/	213
/zh/docs/languages/go/getting-started/	205
/zh/docs/languages/java/configuration/	197
/zh/docs/collector/configuration/	196
/zh/docs/demo/docker-deployment/	176
/zh/docs/concepts/components/	170
/zh/docs/languages/	167
/zh/docs/languages/java/getting-started/	146
/zh/docs/languages/go/	143
/zh/docs/languages/java/instrumentation/	143
/zh/docs/demo/collector-data-flow-dashboard/	128
/zh/docs/concepts/signals/metrics/	125
/zh/docs/concepts/signals/	115
/zh/docs/concepts/instrumentation/zero-code/	110
/zh/docs/concepts/instrumentation/code-based/	106
/zh/docs/demo/kubernetes-deployment/	101
/zh/docs/collector/deployment/agent/	99
/zh/docs/kubernetes/getting-started/	98
/zh/docs/concepts/signals/logs/	94
/zh/docs/zero-code/java/agent/configuration/	94
/zh/docs/languages/go/instrumentation/	93
/zh/docs/languages/python/getting-started/	88
/zh/docs/concepts/semantic-conventions/	87
/zh/docs/demo/development/	85
/zh/docs/zero-code/	84
/zh/docs/collector/deployment/no-collector/	79
/zh/docs/languages/java/libraries/	77
/zh/docs/kubernetes/	75
/zh/docs/concepts/signals/baggage/	71
/zh/docs/collector/deployment/	70
/zh/docs/kubernetes/collector/components/	69
/zh/docs/languages/cpp/getting-started/	67
/zh/docs/languages/java/exporters/	67
/zh/docs/concepts/instrumentation/libraries/	65
/zh/docs/languages/python/	64
/zh/docs/zero-code/java/agent/	64
/zh/docs/concepts/instrumentation/	57
/zh/docs/languages/go/exporters/	56
/zh/docs/zero-code/go/	55
/zh/docs/languages/python/instrumentation/	53
/zh/docs/collector/deployment/gateway/	51
/zh/docs/kubernetes/operator/	49
/zh/docs/kubernetes/helm/collector/	48
/zh/docs/kubernetes/operator/automatic/	48
/zh/docs/languages/java/examples/	48
/zh/docs/demo/services/ad/	45
/zh/docs/languages/sdk-configuration/general/	45
/zh/docs/concepts/sampling/	44
/zh/docs/languages/sdk-configuration/otlp-exporter/	44
/zh/docs/what-is-opentelemetry/	1337
/zh/	1076
/zh/docs/getting-started/dev/	856
/zh/docs/	593
/zh/docs/getting-started/	567
/zh/docs/demo/	480
/zh/docs/getting-started/ops/	459
/zh/docs/concepts/observability-primer/	391
/zh/docs/concepts/	321
/zh/docs/concepts/context-propagation/	296
/zh/docs/demo/architecture/	260
/zh/docs/collector/quick-start/	248
/zh/docs/concepts/signals/traces/	242
/zh/docs/languages/java/	227
/zh/docs/collector/	220
/zh/docs/collector/installation/	213
/zh/docs/languages/go/getting-started/	205
/zh/docs/languages/java/configuration/	197
/zh/docs/collector/configuration/	196
/zh/docs/demo/docker-deployment/	176
/zh/docs/concepts/components/	170
/zh/docs/languages/	167
/zh/docs/languages/java/getting-started/	146
/zh/docs/languages/go/	143
/zh/docs/languages/java/instrumentation/	143
/zh/docs/demo/collector-data-flow-dashboard/	128
/zh/docs/concepts/signals/metrics/	125
/zh/docs/concepts/signals/	115
/zh/docs/concepts/instrumentation/zero-code/	110
/zh/docs/concepts/instrumentation/code-based/	106
/zh/docs/demo/kubernetes-deployment/	101
/zh/docs/collector/deployment/agent/	99
/zh/docs/kubernetes/getting-started/	98
/zh/docs/concepts/signals/logs/	94
/zh/docs/zero-code/java/agent/configuration/	94
/zh/docs/languages/go/instrumentation/	93
/zh/docs/languages/python/getting-started/	88
/zh/docs/concepts/semantic-conventions/	87
/zh/docs/demo/development/	85
/zh/docs/zero-code/	84
/zh/docs/collector/deployment/no-collector/	79
/zh/docs/languages/java/libraries/	77
/zh/docs/kubernetes/	75
/zh/docs/concepts/signals/baggage/	71
/zh/docs/collector/deployment/	70
/zh/docs/kubernetes/collector/components/	69
/zh/docs/languages/cpp/getting-started/	67
/zh/docs/languages/java/exporters/	67
/zh/docs/concepts/instrumentation/libraries/	65
/zh/docs/languages/python/	64
/zh/docs/zero-code/java/agent/	64
/zh/docs/concepts/instrumentation/	57
/zh/docs/languages/go/exporters/	56
/zh/docs/zero-code/go/	55
/zh/docs/languages/python/instrumentation/	53
/zh/docs/collector/deployment/gateway/	51
/zh/docs/kubernetes/operator/	49
/zh/docs/kubernetes/helm/collector/	48
/zh/docs/kubernetes/operator/automatic/	48
/zh/docs/languages/java/examples/	48
/zh/docs/demo/services/ad/	45
/zh/docs/languages/sdk-configuration/general/	45
/zh/docs/concepts/sampling/	44
/zh/docs/languages/sdk-configuration/otlp-exporter/	44

chalin commented 1 month ago

/cc @open-telemetry/docs-zh-approvers

zhihali commented 1 month ago

@ thanks @chalin, I will open some PRs for translation of zh. This would be fun 🙂

chalin commented 1 month ago

FYI, I repurposed this issue to focus only on (2). We'll track (1) via #4898. We'll probably close this issue soon since, as I mentioned, we know that all the localizations are work in progress.

zhihali commented 1 month ago

Path Views /zh/docs/what-is-opentelemetry/ 1337 ...

Thanks for sharing these statistics. Could you clarify if these view counts are from the past month, past year, or some other time period?

chalin commented 1 month ago

Hi @zhihali - I can't recall the default parameters used when I generated the report, but IMHO, the important thing here (relative to your question of which pages get the most traffic and would be most valuable to translate) is the order of the paths in that list.

open-telemetry / opentelemetry.io