Rails 4 schema changes docs #1093
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
cupakromer
commented
Jun 16, 2014
cupakromer
commented
- Restructure the docs to remove duplication
- Extract details from README to keep it focused and not be a full upgrade guide
- Add missing docs as noted in Rails 4.1.0.rc1 no longer defines db:test:prepare #936
| documentation](https://www.relishapp.com/rspec/rspec-rails/v/3-0/docs/directory-structure) for more details. | ||
|
|
||
| <a name="default-helper-files"></a> | ||
| ## Default helper files created in RSpec 3.x have changed |
There was a problem hiding this comment.
I might put this at the top of the list since other items on the list reference rails_helper.rb and it may not be clear what that is if they are reading these caveats in-order.
There was a problem hiding this comment.
Good idea. I could also put a small jump list at the top too.
|
More docs good :) |
Duplicating the documentation in two places was causing some information to be dropped. Additionally, the README.md file was starting to be consumed by the upgrade notes. - Use the feature documentation as the primary location for the upgrade docs. - List the important topics users need to be aware of in the README and link them to the section of the upgrade guide
Extract out the upgrade notes from 1.x to 2.x so they are still easy to find. Make the primary upgrade docs the main page.
Put the more important changes at the top of the page so that they are read first. Placing the helper file changes first as the other changes reference `rails_helper`. The next most important change is the disabling of inferred metadata; as it has been a common source of upgrade questions.
- Remove the reference to "magical" to clear up it's meaning - Make statements more declarative by removing personal "you"
|
Rebased against |
soulcutter
added a commit
that referenced
this pull request
Jun 20, 2014
Rails 4 schema changes docs
cupakromer
added a commit
that referenced
this pull request
Jun 21, 2014
A few more grammar changes based on feedback. - Remove the reference to "magical" to clear up it's meaning - Make statements more declarative by removing personal "you"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.