Skip to content

Comments

[RF-DOCS ] Update Upgrading Rails Guide [ci-skip]#4

Open
OughtPuts wants to merge 14 commits intomainfrom
harriet-guides-upgrading-rails
Open

[RF-DOCS ] Update Upgrading Rails Guide [ci-skip]#4
OughtPuts wants to merge 14 commits intomainfrom
harriet-guides-upgrading-rails

Conversation

@OughtPuts
Copy link
Owner

Motivation / Background

This PR has been created to update the Upgrading Rails Guide as part of the Rails Documentation project.

Detail

The following changes have been made:

  • Upgrade sections before Rails version 6.0 have been moved into separate guides as suggested, to keep the length of the guide manageable.
  • The guides index page has been updated to include links to the new guides.
  • An index of older upgrade sections has been added to the main upgrade guide.
  • The Update Task section has been adjusted and this section has been highlighted in other sections to draw more attention to it.
  • General readability has been improved and the pages have been column wrapped.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@OughtPuts OughtPuts changed the title Harriet guides upgrading rails [RF-DOCS ] Update Upgrading Rails Guide [ci-skip] Aug 8, 2025
@OughtPuts OughtPuts requested review from Ridhwana, bhumi1102 and p8 August 11, 2025 16:43
Copy link
Collaborator

@Ridhwana Ridhwana left a comment

Choose a reason for hiding this comment

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

NOTE: I've reviewed up until line ~140-ish, will continue reviewing

Comment on lines 15 to 18
Before attempting to upgrade an existing application, you should be sure you
have a good reason to upgrade. You need to balance several factors: the need for
new features, gem compatibility, the increasing difficulty of finding support
for old code and your available time and skills, to name a few.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(non-blocking, suggestion): I felt that this reads a bit awkward, and I took a stab at rephrasing.

Suggested change
Before attempting to upgrade an existing application, you should be sure you
have a good reason to upgrade. You need to balance several factors: the need for
new features, gem compatibility, the increasing difficulty of finding support
for old code and your available time and skills, to name a few.
Before upgrading an existing application, make sure you have a clear reason for
doing so. Weigh factors such as the need for new features, gem compatibility,
the decreasing availability of support for older code, and the time and skills
you have available.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this less defeatist rephrasing is good improvement.
Upgrades of recent version should be much easier than 3.2 to 4.0, for example.

And while I think it is good to warn about attempting to upgrade, I think keeping up-to-date with the latest release is much more encouraged these days (with companies running on main) compared to 2011, when this guide was first written.

I think it would be a good idea to have a paragraph before this that recommends/encourages upgrading.
Maybe something like:

Newer Rails versions introduce new features and performance improvements.
Keeping your Rails application up to date with maintained versions makes sure your application keeps getting security fixes.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Great, thanks both! I put the recommendation after the intro paragraph instead so we end on a positive :) as follows:

Upgrading an application can be a difficult process, so make sure you have a clear reason for doing so. Weigh up factors such as the need for new features, gem compatibility, the decreasing availability of support for older code and the time and skills you have available.

Newer Rails versions introduce new features and improvements, so keeping your application up to date with maintained versions will ensure it receives these benefits.

In Rails 7.2, all tests will respect the `queue_adapter` config if provided.
This may cause test errors, if you had set the `queue_adapter` config to
something other than `:test`, but written tests in a way that was dependent on
the `TestAdapter`.

If no config is provided, the `TestAdapter` will continue to be used.

Upgrading from Rails 7.0 to Rails 7.1
Copy link
Collaborator

@Ridhwana Ridhwana Aug 17, 2025

Choose a reason for hiding this comment

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

Are we able to make these subheadings more concise and shorter? They are quite long and if I'm being honest dont male complete sense to me when read in isolation.

CleanShot 2025-08-17 at 14 24 09@2x

Copy link
Owner Author

Choose a reason for hiding this comment

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

@Ridhwana thanks for this one! I'm having a look but it occurred to me it's quite nice to see a sort of one-sentence summary of the changes in that release when the reader looks down the list of subheadings. If we shorten them e.g. 'all tests now respect the active_job.queue_adapter config' -> 'tests and active_job.queue_adapter' I think we lose information about the nature of the change.

Is the above what you had in mind or have you got a better solution? Also, which don't make sense to you? I can have a go at rewording some specific sub headings if you think they are badly worded.

Copy link
Collaborator

@Ridhwana Ridhwana left a comment

Choose a reason for hiding this comment

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

I've reviewed the main file upgrading_ruby_on_rails.md. I need to review the other upgrade files.

Sorry for the delay on this PR, this one is a big one 😅

@bhumi1102
Copy link
Collaborator

Hi @OughtPuts - not sure if you've already seen this, but wanted to leave this community feedback/request for the upgrade guides for you here https://youtu.be/R9_2YUUrQ-g?t=1412 (This is from a RailsConf 2025 talk).

Comment on lines 15 to 18
Before attempting to upgrade an existing application, you should be sure you
have a good reason to upgrade. You need to balance several factors: the need for
new features, gem compatibility, the increasing difficulty of finding support
for old code and your available time and skills, to name a few.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this less defeatist rephrasing is good improvement.
Upgrades of recent version should be much easier than 3.2 to 4.0, for example.

And while I think it is good to warn about attempting to upgrade, I think keeping up-to-date with the latest release is much more encouraged these days (with companies running on main) compared to 2011, when this guide was first written.

I think it would be a good idea to have a paragraph before this that recommends/encourages upgrading.
Maybe something like:

Newer Rails versions introduce new features and performance improvements.
Keeping your Rails application up to date with maintained versions makes sure your application keeps getting security fixes.

@OughtPuts OughtPuts force-pushed the harriet-guides-upgrading-rails branch from f5764ac to 83a8d81 Compare October 18, 2025 09:26
@OughtPuts OughtPuts force-pushed the harriet-guides-upgrading-rails branch from 022ce58 to fe728d0 Compare October 30, 2025 11:33
@github-actions github-actions bot added the docs label Oct 30, 2025
@OughtPuts OughtPuts force-pushed the harriet-guides-upgrading-rails branch from fe728d0 to 77ac07d Compare November 19, 2025 19:41
@OughtPuts OughtPuts force-pushed the harriet-guides-upgrading-rails branch from 7aeb79e to c012d0b Compare November 24, 2025 16:40
@OughtPuts OughtPuts force-pushed the harriet-guides-upgrading-rails branch from c012d0b to b484eac Compare November 24, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants