Skip to content

Backport doc updates and remove RubyGem dependency #1105

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

Merged
merged 8 commits into from
Jun 21, 2014

Conversation

cupakromer
Copy link
Member

soulcutter and others added 8 commits June 21, 2014 00:10
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.
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"
@cupakromer
Copy link
Member Author

Just a sanity check on my part. I plan on merging this in the AM.

cupakromer added a commit that referenced this pull request Jun 21, 2014
Backport doc updates and remove RubyGem dependency
@cupakromer cupakromer merged commit ff71085 into 3-0-maintenance Jun 21, 2014
@cupakromer cupakromer deleted the backports branch June 21, 2014 16:29
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

Successfully merging this pull request may close these issues.

2 participants