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
mention jsonapi-rb for people specifically looking for jsonapi serialization #2195
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e1e2437
mention it
NullVoxPopuli 5bffed0
pr feedback
NullVoxPopuli 0c89335
more pr feedback
NullVoxPopuli 9ede2ec
slim down the readme a bit
NullVoxPopuli cbbf615
slim down the readme a bit
NullVoxPopuli cde32e7
slim down the readme a bit
NullVoxPopuli 3696bcc
slim down the readme a bit
NullVoxPopuli 87a6b4a
readme updates
NullVoxPopuli 9d9f640
readme updates
NullVoxPopuli d306c29
readme updates
NullVoxPopuli d45ea58
readme updates
NullVoxPopuli File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,7 @@ | |
|
||
## About | ||
|
||
## Installation | ||
|
||
## Getting Started | ||
ActiveModelSerializers is undergoing some renovations. See [Development Status](#status-of-ams). | ||
|
||
## Getting Help | ||
|
||
|
@@ -22,31 +20,63 @@ Thanks! | |
If you're reading this at https://github.com/rails-api/active_model_serializers you are | ||
reading documentation for our `master`, which is not yet released. | ||
|
||
Please see below for the documentation relevant to you. | ||
|
||
- [0.10 (0-10-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-10-stable) | ||
- [0.10.6 (latest release) Documentation](https://github.com/rails-api/active_model_serializers/tree/v0.10.6) | ||
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/active_model_serializers/0.10.6) | ||
- [Guides](https://github.com/rails-api/active_model_serializers/tree/v0.10.6/docs) | ||
- [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable) | ||
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable) | ||
- [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable) | ||
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable) | ||
<table> | ||
<tr> | ||
<td> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. html. blegh. but the result is nice. |
||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-10-stable'>0.10 (0-10-stable) Documentation | ||
</a> | ||
</td> | ||
<td> | ||
<a href='http://www.rubydoc.info/gems/active_model_serializers/0.10.6'> | ||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' /> | ||
</a> | ||
</td> | ||
<td> | ||
<a href='https://github.com/rails-api/active_model_serializers/tree/v0.10.6/docs'> | ||
Guides | ||
</a> | ||
</td> | ||
</tr> | ||
<tr> | ||
<td> | ||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-9-stable'>0.9 (0-9-stable) Documentation | ||
</a> | ||
</td> | ||
<td> | ||
<a href='http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable'> | ||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' /> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr> | ||
<td> | ||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-8-stable'>0.8 (0-8-stable) Documentation | ||
</a> | ||
</td> | ||
<td> | ||
<a href='http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable'> | ||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' /> | ||
</a> | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
|
||
## Status of AMS | ||
|
||
*Status*: | ||
### *Status*: | ||
|
||
- ❗️ All existing PRs against master will need to be closed and re-opened against 0-10-stable, if so desired | ||
- ❗️ Master, for the moment, won't have any released version of AMS on it. | ||
- :eyes: See below for [alternatives](#alternatives) | ||
|
||
*Changes to 0.10.x maintenance*: | ||
|
||
- The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it | ||
### *Changes to 0.10.x maintenance*: | ||
|
||
- The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it. | ||
- We may choose to make a 0.11.x ( 0-11-stable) release based on 0-10-stable that just removes the deprecations. | ||
|
||
*What's happening to AMS*: | ||
### *What's happening to AMS*: | ||
|
||
- There's been a lot of churn around AMS since it began back in [Rails 3.2](CHANGELOG-prehistory.md) and a lot of new libraries are around and the JSON:API spec has reached 1.0. | ||
- If there is to be a 1.0 release of AMS, it will need to address the general needs of serialization in much the way ActiveJob can be used with different workers. | ||
|
@@ -56,9 +86,15 @@ Please see below for the documentation relevant to you. | |
|
||
See [PR 2121](https://github.com/rails-api/active_model_serializers/pull/2121) where these changes were introduced for more information and any discussion. | ||
|
||
## High-level behavior | ||
|
||
## Architecture | ||
|
||
## Alternatives | ||
|
||
- [jsonapi-rb](http://jsonapi-rb.org/) is a [highly performant](https://gist.github.com/NullVoxPopuli/748e89ddc1732b42fdf42435d773734a) and modular JSON:API-only implementation. There's a vibrant community around it that has produced projects such as [JSON:API Suite](https://jsonapi-suite.github.io/jsonapi_suite/). | ||
|
||
For benchmarks against alternatives, see https://github.com/rails-api/active_model_serializers/tree/benchmarks | ||
|
||
|
||
|
||
## Semantic Versioning | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure