diff options
| author | Tom Christie | 2012-10-17 13:51:15 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-10-17 13:51:22 +0100 |
| commit | b5daa40852fb5936e6cddb31ecda5c4b40175cd4 (patch) | |
| tree | ed633872ab23df44eb39aa95750e6103a47587f4 /docs/topics | |
| parent | 75ebf895ac3dce4b0e4fbe569fc683e16b788a31 (diff) | |
| download | django-rest-framework-b5daa40852fb5936e6cddb31ecda5c4b40175cd4.tar.bz2 | |
Docs tweaks
Diffstat (limited to 'docs/topics')
| -rw-r--r-- | docs/topics/release-notes.md (renamed from docs/topics/changelog.md) | 9 | ||||
| -rw-r--r-- | docs/topics/rest-hypermedia-hateoas.md | 4 |
2 files changed, 9 insertions, 4 deletions
diff --git a/docs/topics/changelog.md b/docs/topics/release-notes.md index 15fb6301..a466f4b1 100644 --- a/docs/topics/changelog.md +++ b/docs/topics/release-notes.md @@ -1,8 +1,12 @@ -# Change Log +# Release Notes + +> Release Early, Release Often +> +> — Eric S. Raymond, [The Cathedral and the Bazaar][cite]. ## 2.0.0 -* **Fix all of the things.** +* **Fix all of the things.** (Well, almost.) * For more information please see the [2.0 migration guide][migration]. --- @@ -108,4 +112,5 @@ * Initial release. +[cite]: http://www.catb.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/ar01s04.html [migration]: migration.md
\ No newline at end of file diff --git a/docs/topics/rest-hypermedia-hateoas.md b/docs/topics/rest-hypermedia-hateoas.md index dda10eb4..8b0309b9 100644 --- a/docs/topics/rest-hypermedia-hateoas.md +++ b/docs/topics/rest-hypermedia-hateoas.md @@ -24,13 +24,13 @@ For a more thorough background, check out Klabnik's [Hypermedia API reading list REST framework is an agnositic Web API toolkit. It does help guide you towards building well-connected APIs, and makes it easy to design appropriate media types, but it does not strictly enforce any particular design style. -## What REST framework *does* provide. +## What REST framework provides. It is self evident that REST framework makes it possible to build Hypermedia APIs. The browseable API that it offers is built on HTML - the hypermedia language of the web. REST framework also includes [serialization] and [parser]/[renderer] components that make it easy to build appropriate media types, [hyperlinked relations][fields] for building well-connected systems, and great support for [content negotiation][conneg]. -## What REST framework *doesn't* provide. +## What REST framework doesn't provide. What REST framework doesn't do is give you is machine readable hypermedia formats such as [Collection+JSON][collection] or HTML [microformats] by default, or the ability to auto-magically create fully HATEOAS style APIs that include hypermedia-based form descriptions and semantically labelled hyperlinks. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope. |