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

Railsガイドのアップグレード #1600

Open
hachi8833 opened this issue Apr 28, 2024 · 2 comments
Open

Railsガイドのアップグレード #1600

hachi8833 opened this issue Apr 28, 2024 · 2 comments

Comments

@hachi8833
Copy link
Collaborator

hachi8833 commented Apr 28, 2024

大きな流れ

以下のニュースに示されているように、The Rails Foundation主導でRailsガイドの大きな改定が進行している。

docsラベルの付いた以下のissueで進められている。

特にrails foundationタグのついた以下のプルリクは、The Rails Foundationの肝いりで大幅な改定が進められている。

また、次回の安定版Railsリリース(ただしどのバージョンかは示されていない)では、Guidesのスタイルも大幅に見直されることが以下で発表されており、edgeguidesでは既に新スタイルが適用されている。

前提

  • Guidesのスタイル変更は、コンテンツそのものにはほぼ影響しないと予想しているが、Railsガイドが今後Guidesのスタイル変更に追従するかどうかは別途検討が必要。
  • Guidesの更新量は多くなることが見込まれるが、コンテンツの変動はしばらく続くと予測される。このため、半端なタイミングで更新翻訳を行うと手戻りが増えると予想される。
  • そこで基本的には次期安定版Railsがリリースされるまでは更新翻訳の準備を行うに留める。
    • ただし早期にコンテンツ更新が落ち着いたと思われるGuidesがあれば、先行してRailsガイドの更新翻訳を進めることも検討する。
    • Guidesのコンテンツ更新は文章だけではなく、一部の図にも及んでいるので、図も更新する必要がある。
    • 現時点では、以下の差分がある

参考: Comparing v7.1.3...main · rails/rails

確認すべき点

ドキュメントの改定がどのマイルストーンで区切られるのかを確認する必要がある(現在foundation@rubyonrails.orgに問い合わせ中)。

GuidesのChangelogは現在は空だが、fb6c600を見る限りではGuidesは7.2を目標としているように見える。

@hachi8833
Copy link
Collaborator Author

hachi8833 commented May 26, 2024

現時点で https://github.com/rails/rails/milestone/83 が残り1個になったので、7.2ガイド更新の準備を進めます。

定番更新

  • 7.2リリースノート(新規)
  • Upgrading Rails

メジャー更新翻訳

  • Action Mailbox Basics
  • Action Text Overview
  • Active Job Basics
  • Active Model Basics
  • Active Record Basics
  • Action View Overview
  • Action View Helpers

新規翻訳

下の2つは関連の更新あり

  • Getting Started with Dev Containers
    • Getting Started Guide
    • Command Line Guide

@hachi8833
Copy link
Collaborator Author

hachi8833 commented May 28, 2024

まだマージされていませんが、7.2マイルストーンで"Tuning Performance for Deployment"ガイドが追加されていました(その後マージ)。

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

No branches or pull requests

2 participants
@hachi8833 and others