From b5daa40852fb5936e6cddb31ecda5c4b40175cd4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 17 Oct 2012 13:51:15 +0100 Subject: [PATCH] Docs tweaks --- docs/index.md | 4 ++-- docs/template.html | 2 +- docs/topics/{changelog.md => release-notes.md} | 9 +++++++-- docs/topics/rest-hypermedia-hateoas.md | 4 ++-- 4 files changed, 12 insertions(+), 7 deletions(-) rename docs/topics/{changelog.md => release-notes.md} (93%) diff --git a/docs/index.md b/docs/index.md index 4ccafeeb8..02bda0813 100644 --- a/docs/index.md +++ b/docs/index.md @@ -104,7 +104,7 @@ General guides to using REST framework. * [REST, Hypermedia & HATEOAS][rest-hypermedia-hateoas] * [Contributing to REST framework][contributing] * [2.0 Migration Guide][migration] -* [Change Log][changelog] +* [Release Notes][release-notes] * [Credits][credits] ## Development @@ -190,7 +190,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [rest-hypermedia-hateoas]: topics/rest-hypermedia-hateoas.md [contributing]: topics/contributing.md [migration]: topics/migration.md -[changelog]: topics/changelog.md +[release-notes]: topics/release-notes.md [credits]: topics/credits.md [group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework diff --git a/docs/template.html b/docs/template.html index 8051fe995..45bada548 100644 --- a/docs/template.html +++ b/docs/template.html @@ -78,7 +78,7 @@
  • REST, Hypermedia & HATEOAS
  • Contributing to REST framework
  • 2.0 Migration Guide
    • -
  • Change Log
    • +
  • Release Notes
  • Credits
    • diff --git a/docs/topics/changelog.md b/docs/topics/release-notes.md similarity index 93% rename from docs/topics/changelog.md rename to docs/topics/release-notes.md index 15fb63014..a466f4b18 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 dda10eb4b..8b0309b96 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.