Link to 0.10.3 tag instead of master branch
#2000
Merged
Conversation
This file contains 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
|
@berfarah, thanks for your PR! By analyzing the history of the files in this pull request, we identified @bf4, @isratrade and @NullVoxPopuli to be potential reviewers. |
bf4
reviewed
Dec 12, 2016
| @@ -84,8 +84,8 @@ If you'd like to chat, we have a [community slack](http://amserializers.herokuap | |||
| Thanks! | |||
|
|
|||
| ## Documentation | |||
| - [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master) | |||
| - [](http://www.rubydoc.info/gems/active_model_serializers/0.10.2) | |||
| - [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/commit/cd09e890064d2611f2977975163224e12e119568) | |||
There was a problem hiding this comment.
should be https://github.com/rails-api/active_model_serializers/tree/v0.10.3 but really we need a note like:
**If you're viewing this at https://github.com/rails-api/active_model_serializers,
you're reading the documentation for the master branch.
View documentation for the latest release.... etc
bf4
reviewed
Dec 12, 2016
| @@ -84,8 +84,8 @@ If you'd like to chat, we have a [community slack](http://amserializers.herokuap | |||
| Thanks! | |||
|
|
|||
| ## Documentation | |||
| - [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master) | |||
There was a problem hiding this comment.
it does say 0.10 (master) :) ¯\_(ツ)_/¯
There was a problem hiding this comment.
Gooooooooood point. Would you like me to create a link for [0.10.3] instead and keep master there? Or shall I just rename it?
|
@berfarah ping me when you've finished the updates. Let's keep the link to master and add a link to the most recent released version. That would probably be most useful. And we should highlight the release. I think the master was there because there had been some long gaps between releases. |
|
@bf4 I've updated the commit to highlight the latest release, keep master and added a note about which version of the docs people would be reading. Let me know what you think :) |
bf4
reviewed
Dec 14, 2016
| @@ -84,8 +84,14 @@ If you'd like to chat, we have a [community slack](http://amserializers.herokuap | |||
| Thanks! | |||
|
|
|||
| ## Documentation | |||
|
|
|||
| If you're reading this at github.com/rails-api/active_model_serializers you are | |||
It may be less confusing for new users if the docs link them to the current stable release. It could reduce issues like [this one](#1988)
bf4
added a commit
that referenced
this pull request
Jan 6, 2017
Link to 0.10.3 tag instead of `master` branch
bf4
added a commit
that referenced
this pull request
Jan 10, 2017
* Merge pull request #1990 from mxie/mx-result-typo Fix typos and capitalization in Relationship Links docs [ci skip] * Merge pull request #1992 from ojiry/bump_ruby_versions Run tests by Ruby 2.2.6 and 2.3.3 * Merge pull request #1994 from bf4/promote_architecture Promote important architecture description that answers a lot of questions we get Conflicts: docs/ARCHITECTURE.md * Merge pull request #1999 from bf4/typos Fix typos [ci skip] * Merge pull request #2000 from berfarah/patch-1 Link to 0.10.3 tag instead of `master` branch * Merge pull request #2007 from bf4/check_ci Test was failing due to change in JSON exception message when parsing empty string * Swap out KeyTransform for CaseTransform (#1993) * delete KeyTransform, use CaseTransform * added changelog Conflicts: CHANGELOG.md * Merge pull request #2005 from kofronpi/support-ruby-2.4 Update jsonapi runtime dependency to 0.1.1.beta6 * Bump to v0.10.4 * Merge pull request #2018 from rails-api/bump_version Bump to v0.10.4 [ci skip] Conflicts: CHANGELOG.md * Merge pull request #2019 from bf4/fix_method_redefined_warning Fix AMS warnings * Merge pull request #2020 from bf4/silence_grape_warnings Silence Grape warnings * Merge pull request #2017 from bf4/remove_warnings Fix mt6 assert_nil warnings * Updated isolated tests to assert correct behavior. (#2010) * Updated isolated tests to assert correct behavior. * Added check to get unsafe params if rails version is great than 5 * Merge pull request #2012 from bf4/cleanup_isolated_jsonapi_renderer_tests_a_bit Cleanup assertions in isolated jsonapi renderer tests a bit * Add Model#attributes helper; make test attributes explicit * Fix model attributes accessors * Fix typos * Randomize testing of compatibility layer against regressions * Test bugfix * Add CHANGELOG * Merge pull request #1981 from groyoh/link_doc Fix relationship links doc Conflicts: CHANGELOG.md
GregPK
pushed a commit
to GregPK/active_model_serializers
that referenced
this pull request
Apr 25, 2017
* Merge pull request rails-api#1990 from mxie/mx-result-typo Fix typos and capitalization in Relationship Links docs [ci skip] * Merge pull request rails-api#1992 from ojiry/bump_ruby_versions Run tests by Ruby 2.2.6 and 2.3.3 * Merge pull request rails-api#1994 from bf4/promote_architecture Promote important architecture description that answers a lot of questions we get Conflicts: docs/ARCHITECTURE.md * Merge pull request rails-api#1999 from bf4/typos Fix typos [ci skip] * Merge pull request rails-api#2000 from berfarah/patch-1 Link to 0.10.3 tag instead of `master` branch * Merge pull request rails-api#2007 from bf4/check_ci Test was failing due to change in JSON exception message when parsing empty string * Swap out KeyTransform for CaseTransform (rails-api#1993) * delete KeyTransform, use CaseTransform * added changelog Conflicts: CHANGELOG.md * Merge pull request rails-api#2005 from kofronpi/support-ruby-2.4 Update jsonapi runtime dependency to 0.1.1.beta6 * Bump to v0.10.4 * Merge pull request rails-api#2018 from rails-api/bump_version Bump to v0.10.4 [ci skip] Conflicts: CHANGELOG.md * Merge pull request rails-api#2019 from bf4/fix_method_redefined_warning Fix AMS warnings * Merge pull request rails-api#2020 from bf4/silence_grape_warnings Silence Grape warnings * Merge pull request rails-api#2017 from bf4/remove_warnings Fix mt6 assert_nil warnings * Updated isolated tests to assert correct behavior. (rails-api#2010) * Updated isolated tests to assert correct behavior. * Added check to get unsafe params if rails version is great than 5 * Merge pull request rails-api#2012 from bf4/cleanup_isolated_jsonapi_renderer_tests_a_bit Cleanup assertions in isolated jsonapi renderer tests a bit * Add Model#attributes helper; make test attributes explicit * Fix model attributes accessors * Fix typos * Randomize testing of compatibility layer against regressions * Test bugfix * Add CHANGELOG * Merge pull request rails-api#1981 from groyoh/link_doc Fix relationship links doc Conflicts: CHANGELOG.md
ledhed2222
pushed a commit
to ledhed2222/active_model_serializers
that referenced
this pull request
Nov 4, 2017
Link to 0.10.3 tag instead of `master` branch
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.
Purpose
Link to latest tagged release so people can read the latest docs for an available release.
Changes
Updated links
Caveats
These links have to be updated with every release
Related GitHub issues
#1988
Additional helpful information
It may be less confusing for new users if the docs link them to the current stable release.