Skip to content

Add Japanese translation of "token rotation" docment - #418

Merged
seratch merged 2 commits into
slackapi:mainfrom
hirosassa:414-token-rotation-doc-ja
Jul 22, 2021
Merged

seratch merged 2 commits into
slackapi:mainfrom
hirosassa:414-token-rotation-doc-ja

Conversation

@hirosassa

Copy link
Copy Markdown
Contributor

(Describe the goal of this PR. Mention any related Issue numbers)

Related to #414
I added Japanese translation of Token rotation document introduced in #413.

Category (place an x in each of the [ ])

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements (place an x in each [ ])

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run ./scripts/install_all_and_run_tests.sh after making the changes.

@seratch seratch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To complete this work, may I ask you to update the "order:" numbers as the English document pull request does: https://github.com/slackapi/bolt-python/pull/413/files

Comment thread docs/_advanced/ja_token_rotation.md Outdated
---

<div class="section-content">
Bolt for Python [v1.7.0](https://github.com/slackapi/bolt-python/releases/tag/v1.7.0) より、[OAuth V2 RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4) で規定され、アクセストークンに対するセキュリティを強化する、トークンローテーションを提供しています。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for better alignment with the original sentence. In my opinion, it's fine to split the English sentence into two if it's easier to read in Japanese.

Suggested change
Bolt for Python [v1.7.0](https://github.com/slackapi/bolt-python/releases/tag/v1.7.0) より、[OAuth V2 RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4) で規定され、アクセストークンに対するセキュリティを強化する、トークンローテーションを提供しています。
Bolt for Python [v1.7.0](https://github.com/slackapi/bolt-python/releases/tag/v1.7.0) から、アクセストークンのさらなるセキュリティ強化のレイヤーであるトークンローテーションの機能に対応しています。トークンローテーションは [OAuth V2 の RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4) で規定されているものです。

Comment thread docs/_advanced/ja_token_rotation.md Outdated
<div class="section-content">
Bolt for Python [v1.7.0](https://github.com/slackapi/bolt-python/releases/tag/v1.7.0) より、[OAuth V2 RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4) で規定され、アクセストークンに対するセキュリティを強化する、トークンローテーションを提供しています。

既存の Slack app のアクセストークンが無期限に存在し続けるのに対し、トークンローテーションを有効にすると、アクセストークンは失効します。これに対し、リフレッシュトークンを用いて、長期にわたりアクセストークンの更新行います。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • We use "Slack アプリ" for Slack app
  • "トークンローテーションを有効にしたアプリでは" is not a directly translated phrase but it should be easier to understand for anyone
  • No need to have "これに対し、"
Suggested change
既存の Slack app のアクセストークンが無期限に存在し続けるのに対し、トークンローテーションを有効にすると、アクセストークンは失効します。これに対し、リフレッシュトークンを用いて、長期にわたりアクセストークンの更新行います。
既存の Slack アプリではアクセストークンが無期限に存在し続けるのに対して、トークンローテーションを有効にしたアプリではアクセストークンが失効するようになります。リフレッシュトークンを利用して、アクセストークンを長期間にわたって更新し続けることができます。

Comment thread docs/_advanced/ja_token_rotation.md Outdated

既存の Slack app のアクセストークンが無期限に存在し続けるのに対し、トークンローテーションを有効にすると、アクセストークンは失効します。これに対し、リフレッシュトークンを用いて、長期にわたりアクセストークンの更新行います。

Bolt for Python は[組み込みの OAuth](https://slack.dev/bolt-python/concepts#authenticating-oauth) が使用されている場合、自動的にトークンローテーションを行います。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your translation here is already great enough but we can make the sentence a bit clearer this way:

Suggested change
Bolt for Python は[組み込みの OAuth](https://slack.dev/bolt-python/concepts#authenticating-oauth) が使用されている場合、自動的にトークンローテーションを行います。
[Bolt for Python の組み込みの OAuth 機能](https://slack.dev/bolt-python/concepts#authenticating-oauth) を使用していれば、Bolt for Python が自動的にトークンローテーションの処理をハンドリングします。

Comment thread docs/_advanced/ja_token_rotation.md Outdated

Bolt for Python は[組み込みの OAuth](https://slack.dev/bolt-python/concepts#authenticating-oauth) が使用されている場合、自動的にトークンローテーションを行います。

トークンローテーションについての詳細な情報は、この[ドキュメント](https://api.slack.com/authentication/rotation)をご覧ください。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with other pages:

Suggested change
トークンローテーションについての詳細な情報は、この[ドキュメント](https://api.slack.com/authentication/rotation)をご覧ください。
トークンローテーションに関する詳細は [API ドキュメント](https://api.slack.com/authentication/rotation)を参照してください。

@seratch

seratch commented Jul 22, 2021

Copy link
Copy Markdown
Contributor

@hirosassa Thanks for taking the time to make this pull request! Can you check my review comments?

@seratch seratch added the docs Improvements or additions to documentation label Jul 22, 2021
@seratch seratch added this to the 1.8.0 milestone Jul 22, 2021
@hirosassa

Copy link
Copy Markdown
Contributor Author

@seratch Thanks for your review! I applied suggested changes.

@seratch seratch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick update. Looks great to me 👍

@codecov

codecov Bot commented Jul 22, 2021

Copy link
Copy Markdown

Codecov Report

Merging #418 (5fb5509) into main (35baf08) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #418   +/-   ##
=======================================
  Coverage   91.36%   91.36%           
=======================================
  Files         167      167           
  Lines        5491     5491           
=======================================
  Hits         5017     5017           
  Misses        474      474           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 35baf08...5fb5509. Read the comment docs.

@seratch
seratch merged commit 2b818f7 into slackapi:main Jul 22, 2021
@hirosassa
hirosassa deleted the 414-token-rotation-doc-ja branch July 22, 2021 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants