Updates to the Migration Guide #8375
Conversation
|
The intro is a very nice improvement. It might make sense to add some content about using migrations to seed data vs. seeds.rb vs. other approaches. I hear that talked about a decent amount and it seems like the "rails way" is to use seeds.rb, so maybe that deserves mention. I didn't see it anywhere in the guide, so apologies if it is and I missed it. |
| creating extra work for yourself and your co-workers and cause major headaches | ||
| if the existing version of the migration has already been run on production | ||
| machines. Instead, you should write a new migration that performs the changes | ||
| you require. Editing a freshly generated migration that has not yet been |
There was a problem hiding this comment.
Just a detail but there are two spaces just after the dot (even on the line 605). :)
There was a problem hiding this comment.
Ugh. That was left from before. I'll fix those.
|
@barelyknown that would be a good idea, yes. there's nothing about this currently. |
| Active Record provides methods that perform common data definition tasks in a | ||
| database independent way (you'll read about them in detail later): | ||
|
|
||
| * `add_column` |
There was a problem hiding this comment.
This list is useful to me. I always forget what are the supported methods and I always look this guide.
There was a problem hiding this comment.
I'm always torn: guides should have just the most useful stuff, not have a copy of everything in the API docs. Maybe there's a better balance to be struck here.
There was a problem hiding this comment.
It is true. Maybe I'm looking in the wrong place ;)
There was a problem hiding this comment.
I understand why you're torn about this, but this makes it feel complete. One gets a better understanding of what DDL changes are possible with migrations. At the very least, please retain a link to the relevant API documentation.
There was a problem hiding this comment.
Yeah, I'll put an API doc link. we should use more of those.
There was a problem hiding this comment.
There is something solvable but unsolved, which is a way to link to the API (or viceversa) that links to edge in edge, and to stable in stable.
Absolute or relative paths work out of the box for in-guides or in-API links, but we need to invent something for cross-references.
|
Updated to fix both the spacing issue and the db/seeds issue. |
|
Rebased and squashed. Unfortunately, GitHub still says no merge even though locally, it looks fine? Hm. :( Still not 100% sure what to do about the API issue. Maybe it's best to leave them in for now. |
This introduces a bunch of editing/re-writing to the migrations guide. There were a bunch of small changes, and a few larger ones: * mysql does support transactions. * Add a section about db/seeds.rb * Largely re-wrote the first few sections
|
Merge-able now. |
|
Nice simplification, I like the new wording. We need to resolve the cross-linking somehow because for completeness the guide should link IMO to listings of column types and macros. Let me think about it. But that is not a blocker, let's merge. |
|
🤘 thanks! |
I'm going to be taking a look at all of the Guides as we get closer to the Rails 4 release. I've done a bunch of work in docrails already, but with these bigger changes to the Guides, I figured that a pull request would be best.
Here are some initial thoughts on improving the Migration Guide. Most of the content changes are at the beginning. Obviously, this will probably be squashed before it's merged.
/cc @fxn @vijaydev