-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
[ja] fix drift of content/ja/docs/what-is-opentelemetry #6511
base: main
Are you sure you want to change the base?
[ja] fix drift of content/ja/docs/what-is-opentelemetry #6511
Conversation
88b5147
to
7dff90a
Compare
7dff90a
to
c7433d1
Compare
- 全コンポーネントの[仕様](/docs/specs/otel) | ||
- テレメトリーデータの形式を定義する標準[プロトコル](/docs/specs/otlp/) | ||
- 共通のテレメトリーデータ型のための標準の命名スキーマを定義する[セマンティック規約](/docs/specs/semconv/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could not pass make check-links-only
when I wrote this link as a below text.
Then, I wrote these contents which are different from original one.
- 全コンポーネントの[仕様](/docs/specs/otel) | |
- テレメトリーデータの形式を定義する標準[プロトコル](/docs/specs/otlp/) | |
- 共通のテレメトリーデータ型のための標準の命名スキーマを定義する[セマンティック規約](/docs/specs/semconv/) | |
- 全コンポーネントの[仕様](../specs/otel) | |
- テレメトリーデータの形式を定義する標準[プロトコル](../specs/otlp/) | |
- 共通のテレメトリーデータ型のための標準の命名スキーマを定義する[セマンティック規約](../specs/semconv/) |
> make check-links-only
tmp/bin/htmltest --skip-external
Skipping the checking of external links.
htmltest started at 01:55:26 on public
========================================================================
running in concurrent mode, this is experimental
ja/docs/what-is-opentelemetry/index.html
target does not exist --- ja/docs/what-is-opentelemetry/index.html --> ../specs/otel
target does not exist --- ja/docs/what-is-opentelemetry/index.html --> ../specs/otlp/
target does not exist --- ja/docs/what-is-opentelemetry/index.html --> ../specs/semconv/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chalin could you take a look?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chalin I took another look at the document. As far as I read this document, localized contents should keep paths in the original contents, but according to @Msksgm, it breaks the test. This PR contains the changes derived from that behavior all over the place, so we need your advice on what to do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you have any ideas that I encountered, please give me an advice.
I'm sorry for bothering you.
Tank you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://opentelemetry.io/docs/contributing/localization/#links によると、 /docs/specs/otlp/
などのままにすべきに見えます。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As @katzchang pointed out, the Japanese page should use the same links as the original English page.
Avoid using make
directly. It is better that you use the NPM scripts to build, check and fix the site. For example, run npm run check:links
to ensure that the site has been fully built before you check links. Let me know if that works for you. (Run npm run
to see the full list of NPM scripts that are available.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@katzchang @chalin
Thank you for teaching me.
It is passed.
> npm run check:links
> precheck:links
> npm run build && npm run fix:htmltest-config
> prebuild
> npm run _prebuild
> _prebuild
> npm run seq -- get:submodule cp:spec
> seq
> bash -c 'for cmd in "$@"; do npm run $cmd || exit 1; done' - get:submodule cp:spec
> get:submodule
> npm run _get:${GET:-submodule} --
> _get:submodule
> set -x && git submodule update --init ${DEPTH:- --depth 999}
+ git submodule update --init --depth 999
Submodule path 'content-modules/semantic-conventions': checked out 'ac424df0d09fae721913f2a399b90ac16ba960fd'
> postget:submodule
> git submodule
f16a58e11ca14982ce5c3cf375c2384422dfb3ac content-modules/community (f16a58e)
fb2ff487c70ac1895652ab5c4a965dfc2ae20d03 content-modules/opamp-spec (v0.10.0)
5661ff0ded32cf1b83f1147dae96ca403c198504 content-modules/opentelemetry-go (exporters/stdout/stdoutlog/v0.3.0)
cce0f6a84169b978bba17b3bf7cbf972a0fda230 content-modules/opentelemetry-java-examples (cce0f6a)
2bd940b2b77c1ab57c27166af21384906da7bb2b content-modules/opentelemetry-proto (v0.11.0-199-g2bd940b)
eb2f6eaa81406e6008804df4df4a8a555365626b content-modules/opentelemetry-specification (v1.42.0)
ac424df0d09fae721913f2a399b90ac16ba960fd content-modules/semantic-conventions (v1.30.0)
cbc714bed7a880469db4c608593af9f9762e4388 themes/docsy (v0.11.0-44-gcbc714b)
> cp:spec
> scripts/content-modules/cp-pages.sh
OTEL SPEC pages: copied and processed
OTLP SPEC pages: copied and processed
OTLP SPEC protos copied and processed
COMMUNITY pages: copied and processed
SEM CONV pages: copied and processed
OpAMP SPEC page: copied and processed
> build
> npm run _build --
> _build
> npm run _hugo -- -e dev --buildDrafts --buildFuture --baseURL "${DEPLOY_PRIME_URL:-http://localhost}"
> _hugo
> hugo --cleanDestinationDir -e dev --buildDrafts --buildFuture --baseURL http://localhost
Start building sites …
hugo v0.145.0-666444f0a52132f9fec9f71cf25b441cc6a4f355+extended darwin/amd64 BuildDate=2025-02-26T15:41:25Z VendorInfo=gohugoio
| EN | ES | FR | JA | PT | ZH
-------------------+-----+-----+-----+-----+-----+------
Pages | 743 | 262 | 259 | 263 | 273 | 266
Paginator pages | 30 | 0 | 0 | 0 | 0 | 0
Non-page files | 254 | 42 | 42 | 42 | 42 | 42
Static files | 202 | 202 | 202 | 202 | 202 | 202
Processed images | 2 | 0 | 0 | 0 | 0 | 0
Aliases | 8 | 0 | 0 | 2 | 2 | 2
Cleaned | 0 | 0 | 0 | 0 | 0 | 0
Total in 197305 ms
> fix:htmltest-config
> scripts/htmltest-config.sh
> check:links
> npm run _check:links
> _check:links
> HTMLTEST_ARGS='--log-level 1' npm run __check:links
> __check:links
> make --keep-going check-links
cp static/refcache.json tmp/.htmltest/
tmp/bin/htmltest --log-level 1
htmltest started at 06:26:11 on public
========================================================================
running in concurrent mode, this is experimental
✔✔✔ passed in 1m35.446212875s
tested 2091 documents
cp tmp/.htmltest/refcache.json static/
npm run _prettier:any -- --write static/refcache.json
> _prettier:any
> npx prettier --ignore-path '' --write static/refcache.json
static/refcache.json 564ms
2de7dde
to
a45cc33
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Msksgm I have commented one thing. Thanks!
2e79f41
to
33fcc49
Compare
Sorry, I added a new commit because new changes occured in this page. |
33fcc49
to
24e1e2d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As @chalin says, please use the same links as the original English page (current PR still uses the relative paths, which is not the same as the original).
- 全コンポーネントの[仕様](/docs/specs/otel) | ||
- テレメトリーデータの形式を定義する標準[プロトコル](/docs/specs/otlp/) | ||
- 共通のテレメトリーデータ型のための標準の命名スキーマを定義する[セマンティック規約](/docs/specs/semconv/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chalin could you take a look?
- 全コンポーネントの[仕様](/docs/specs/otel) | ||
- テレメトリーデータの形式を定義する標準[プロトコル](/docs/specs/otlp/) | ||
- 共通のテレメトリーデータ型のための標準の命名スキーマを定義する[セマンティック規約](/docs/specs/semconv/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chalin I took another look at the document. As far as I read this document, localized contents should keep paths in the original contents, but according to @Msksgm, it breaks the test. This PR contains the changes derived from that behavior all over the place, so we need your advice on what to do.
24e1e2d
to
ee1e965
Compare
@ymotongpoo - the issues that @Msksgm was facing was resolved, see #6511 (comment). Are there still URLs that differ here from the |
ref: #6490
original https://opentelemetry.io/docs/what-is-opentelemetry/
preview https://deploy-preview-6511--opentelemetry.netlify.app/ja/docs/what-is-opentelemetry/