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

APIドキュメントページのリンク誤り? #1570

Closed
amedora opened this issue Mar 19, 2019 · 5 comments · Fixed by #1594
Closed

APIドキュメントページのリンク誤り? #1570

amedora opened this issue Mar 19, 2019 · 5 comments · Fixed by #1594

Comments

@amedora
Copy link
Contributor

amedora commented Mar 19, 2019

概要

APIドキュメントのページに張られているリンクで誤りと思われるものがありました。

詳細

問題のページは以下です。

『参照』に挙げられている『コンポーネント - v-once による安価な静的コンポーネント』を
クリックすると、『動的なコンポーネント』のページに遷移します。

本来意図している遷移先のページは『v-once を使用するチープスタティックコンポーネント』と思われます(英語版のページではそうなっています)。

参考資料など

Windows7のChrome 73.0.3683.75 で確認しました。

@oohira
Copy link
Collaborator

oohira commented Mar 25, 2019

@kazupon 原文ではリダイレクトを使ってセクションの移動を吸収しているようですが、翻訳文ではこの仕組みを使っていないためうまく遷移できなくなっているようです。この手のリンク切れは他にも結構ありそうですが、現状の方針としては「リダイレクトを使わずリンクを直接目的のページに飛ぶよう直す」が正しいでしょうか

  • themes/vue/source/js/common.js
88:      'Cheap-Static-Components-with-v-once':
89:        '/v2/guide/components-edge-cases.html#Cheap-Static-Components-with-v-once'

@kazupon
Copy link
Member

kazupon commented Mar 26, 2019

@oohira

現状の方針としては「リダイレクトを使わずリンクを直接目的のページに飛ぶよう直す」が正しいでしょうか

これまで、日本語公式ドキュメントの方はリダイレクトを使わずに、対応する日本語ドキュメントのURLに直接リンクする形でやってきました。
対応方法については、原文がリダイレクトで対応している方法と、これまでやってきた直接リンクする方法とがあります。
リダイレクトの方が一元管理できるのでメンテナンス面の観点で、そちらの方がいいのと、なるべく原文と同じ方法しておいた方が、原文と日本語の翻訳形式のやり方の差分をなくした方が、今後のためになるので、原文と同じリダイレクトで対応する方法がよいです。

@oohira
Copy link
Collaborator

oohira commented Mar 27, 2019

@kazupon ちょっと悩ましいかもしれません。次の2通りの方法が考えられますが、どちらもイマイチな気がします。

  • 元文書からは日本語ハッシュでリンクする
    • 翻訳済みの文書が本家側である日ページ分割されてリダイレクト設定されたと考えると、こちらが自然
    • ただし、実際にはこのままでは動作しない(キーの部分をURLエンコードした文字列にする必要があるので可読性を犠牲にして v-once-%E3%82%... のように宣言するか、本家とdiffが出る覚悟で map[encodeURIComponent('v-once-を使用...')] = '...' のようにJSを変えてしまうか)
  'v-once-を使用した安価な静的コンポーネント':
    '/v2/guide/components-edge-cases.html#v-once-を使用するチープスタティックコンポーネント'
  • 元文書からは英語ハッシュでリンクする
    • 元文書は翻訳済みなのでリダイレクト設定される前はすでに日本語ハッシュのリンクになっているはずで、いちいち英語ハッシュに戻さなければならなくなってしまう
  'Cheap-Static-Components-with-v-once':
    '/v2/guide/components-edge-cases.html#v-once-を使用するチープスタティックコンポーネント'

@kazupon
Copy link
Member

kazupon commented Mar 30, 2019

@oohira
うーん、悩ましいですね。。。
これまで、直接リンクしていたときも、リンクのハッシュ部分は日本語でURLエンコードしていたので、最初の案の方でいきましょうか。

/cc @potato4d @re-fort
何か妙案があればコメントお願いします。:pray:

oohira added a commit to oohira/jp.vuejs.org that referenced this issue Mar 31, 2019
kazupon pushed a commit that referenced this issue Mar 31, 2019
@oohira
Copy link
Collaborator

oohira commented Apr 1, 2019

@amedora ご報告ありがとうございました 👍

syagawa pushed a commit to syagawa/jp.vuejs.org that referenced this issue Jun 20, 2019
* Moving Components Page into its Own Category

* Add caveat

* Correct link (vuejs#1548)

* Update components.md (vuejs#1557)

I removed the underscores around "prop"erty. I'm not sure what was intended there- maybe bold or italics, but I figured at minimum it should be removed until someone can correct it better.

* (fix) add missing quote in custom-input example (vuejs#1570)

* Translate into Japanese

* fix: invalid link

* chore: unify the terms
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 a pull request may close this issue.

3 participants