From e9dbffb602cf925ce126840db8be6e13277e7b83 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 9 Dec 2013 08:47:06 +0000 Subject: [PATCH] Latest docs build --- api-guide/authentication.html | 2 +- api-guide/content-negotiation.html | 2 +- api-guide/exceptions.html | 2 +- api-guide/fields.html | 2 +- api-guide/filtering.html | 2 +- api-guide/format-suffixes.html | 2 +- api-guide/generic-views.html | 2 +- api-guide/pagination.html | 2 +- api-guide/parsers.html | 2 +- api-guide/permissions.html | 2 +- api-guide/relations.html | 4 ++-- api-guide/renderers.html | 2 +- api-guide/requests.html | 2 +- api-guide/responses.html | 2 +- api-guide/reverse.html | 2 +- api-guide/routers.html | 2 +- api-guide/serializers.html | 2 +- api-guide/settings.html | 2 +- api-guide/status-codes.html | 2 +- api-guide/testing.html | 2 +- api-guide/throttling.html | 2 +- api-guide/views.html | 2 +- api-guide/viewsets.html | 2 +- index.html | 4 ++-- topics/2.2-announcement.html | 2 +- topics/2.3-announcement.html | 2 +- topics/ajax-csrf-cors.html | 2 +- topics/browsable-api.html | 2 +- topics/browser-enhancements.html | 2 +- topics/contributing.html | 19 ++++++++++++++++--- topics/credits.html | 2 +- topics/documenting-your-api.html | 2 +- topics/release-notes.html | 2 +- topics/rest-framework-2-announcement.html | 2 +- topics/rest-hypermedia-hateoas.html | 2 +- topics/writable-nested-serializers.html | 2 +- tutorial/1-serialization.html | 2 +- tutorial/2-requests-and-responses.html | 2 +- tutorial/3-class-based-views.html | 2 +- .../4-authentication-and-permissions.html | 2 +- .../5-relationships-and-hyperlinked-apis.html | 2 +- tutorial/6-viewsets-and-routers.html | 2 +- tutorial/quickstart.html | 2 +- 43 files changed, 60 insertions(+), 47 deletions(-) diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 8bbed7c04..0b869df54 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -189,7 +189,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/content-negotiation.html b/api-guide/content-negotiation.html index 147e11e68..83157c1ed 100644 --- a/api-guide/content-negotiation.html +++ b/api-guide/content-negotiation.html @@ -177,7 +177,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html index 9887d7677..161a69e10 100644 --- a/api-guide/exceptions.html +++ b/api-guide/exceptions.html @@ -184,7 +184,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/fields.html b/api-guide/fields.html index 00c65b1cc..405792e3e 100644 --- a/api-guide/fields.html +++ b/api-guide/fields.html @@ -197,7 +197,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/filtering.html b/api-guide/filtering.html index 6cfa40a33..b367053ba 100644 --- a/api-guide/filtering.html +++ b/api-guide/filtering.html @@ -187,7 +187,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/format-suffixes.html b/api-guide/format-suffixes.html index 1c1f9a4ce..1b8cdae22 100644 --- a/api-guide/format-suffixes.html +++ b/api-guide/format-suffixes.html @@ -175,7 +175,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/generic-views.html b/api-guide/generic-views.html index 2828fa42e..df2368469 100644 --- a/api-guide/generic-views.html +++ b/api-guide/generic-views.html @@ -195,7 +195,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/pagination.html b/api-guide/pagination.html index d3a268fb5..9bbd9a473 100644 --- a/api-guide/pagination.html +++ b/api-guide/pagination.html @@ -179,7 +179,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/parsers.html b/api-guide/parsers.html index a7a878989..f651d7cdd 100644 --- a/api-guide/parsers.html +++ b/api-guide/parsers.html @@ -186,7 +186,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/permissions.html b/api-guide/permissions.html index 8ad8f8c6c..a2df9264c 100644 --- a/api-guide/permissions.html +++ b/api-guide/permissions.html @@ -189,7 +189,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/relations.html b/api-guide/relations.html index 34252036a..218421979 100644 --- a/api-guide/relations.html +++ b/api-guide/relations.html @@ -189,7 +189,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

@@ -250,7 +250,7 @@ class Track(models.Model):

RelatedField may be used to represent the target of the relationship using its __unicode__ method.

For example, the following serializer.

class AlbumSerializer(serializers.ModelSerializer):
-    tracks = RelatedField(many=True)
+    tracks = serializers.RelatedField(many=True)
 
     class Meta:
         model = Album
diff --git a/api-guide/renderers.html b/api-guide/renderers.html
index 1441b7ba5..b1140b881 100644
--- a/api-guide/renderers.html
+++ b/api-guide/renderers.html
@@ -199,7 +199,7 @@
               

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/requests.html b/api-guide/requests.html index 9a496e30d..d0d5704d6 100644 --- a/api-guide/requests.html +++ b/api-guide/requests.html @@ -187,7 +187,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/responses.html b/api-guide/responses.html index b14730378..286d7bfd7 100644 --- a/api-guide/responses.html +++ b/api-guide/responses.html @@ -185,7 +185,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/reverse.html b/api-guide/reverse.html index d6af0887f..434b2fd08 100644 --- a/api-guide/reverse.html +++ b/api-guide/reverse.html @@ -175,7 +175,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/routers.html b/api-guide/routers.html index 0bc72e5ff..458f1f34e 100644 --- a/api-guide/routers.html +++ b/api-guide/routers.html @@ -180,7 +180,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/serializers.html b/api-guide/serializers.html index c7baee146..f9ecb9f00 100644 --- a/api-guide/serializers.html +++ b/api-guide/serializers.html @@ -192,7 +192,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/settings.html b/api-guide/settings.html index f265863ce..10f16a230 100644 --- a/api-guide/settings.html +++ b/api-guide/settings.html @@ -183,7 +183,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html index 6c6a6ff9c..b6bfaadd9 100644 --- a/api-guide/status-codes.html +++ b/api-guide/status-codes.html @@ -179,7 +179,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/testing.html b/api-guide/testing.html index df09659ea..2eae01498 100644 --- a/api-guide/testing.html +++ b/api-guide/testing.html @@ -189,7 +189,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/throttling.html b/api-guide/throttling.html index cb633916f..8800a02d2 100644 --- a/api-guide/throttling.html +++ b/api-guide/throttling.html @@ -182,7 +182,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/views.html b/api-guide/views.html index 8dd319fdd..c63f47ba8 100644 --- a/api-guide/views.html +++ b/api-guide/views.html @@ -180,7 +180,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/api-guide/viewsets.html b/api-guide/viewsets.html index 0b3293e30..5cd380799 100644 --- a/api-guide/viewsets.html +++ b/api-guide/viewsets.html @@ -182,7 +182,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/index.html b/index.html index 468eef085..2ecaed744 100644 --- a/index.html +++ b/index.html @@ -184,7 +184,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

@@ -293,7 +293,7 @@ pip install django-filter # Filtering support

Don't forget to make sure you've also added rest_framework to your INSTALLED_APPS.

We're ready to create our API now. Here's our project's root urls.py module:

-
from django.conf.urls.defaults import url, patterns, include
+
from django.conf.urls import url, patterns, include
 from django.contrib.auth.models import User, Group
 from rest_framework import viewsets, routers
 
diff --git a/topics/2.2-announcement.html b/topics/2.2-announcement.html
index 4b3b1b5b3..e76032ff3 100644
--- a/topics/2.2-announcement.html
+++ b/topics/2.2-announcement.html
@@ -177,7 +177,7 @@
               

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/topics/2.3-announcement.html b/topics/2.3-announcement.html index c2f7eb764..b22a136d3 100644 --- a/topics/2.3-announcement.html +++ b/topics/2.3-announcement.html @@ -189,7 +189,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/topics/ajax-csrf-cors.html b/topics/ajax-csrf-cors.html index 5f7f51ae4..cf33a56e6 100644 --- a/topics/ajax-csrf-cors.html +++ b/topics/ajax-csrf-cors.html @@ -176,7 +176,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/topics/browsable-api.html b/topics/browsable-api.html index 6306c97e2..ba58eec00 100644 --- a/topics/browsable-api.html +++ b/topics/browsable-api.html @@ -176,7 +176,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/topics/browser-enhancements.html b/topics/browser-enhancements.html index c62c7f713..11b53d530 100644 --- a/topics/browser-enhancements.html +++ b/topics/browser-enhancements.html @@ -179,7 +179,7 @@

-

The team behind REST framework are launching a new API service.

+

The team behind REST framework is launching a new API service.

If you want to be first in line when we start issuing invitations, please sign up here:

diff --git a/topics/contributing.html b/topics/contributing.html index 0c1f0da9c..adec4f96c 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -6,7 +6,7 @@ - + @@ -181,11 +181,14 @@
  • Building the documentation
  • Language style
  • Markdown style
  • +
  • Third party packages
  • +
  • Getting started
  • +
  • Linking to your package

  • -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    @@ -220,7 +223,7 @@

    There are many ways you can contribute to Django REST framework. We'd like it to be a community-led project, so please get involved and help shape the future of the project.

    Community

    The most important thing you can do to help push the REST framework project forward is to be actively involved wherever possible. Code contributions are often overvalued as being the primary way to get involved in a project, we don't believe that needs to be the case.

    -

    If you use REST framework, we'd love you to be vocal about your experiances with it - you might consider writing a blog post on your experience with using REST framework, or publishing a tutorial about using the project with a particular javascript framework. Experiances from beginners can be particularly helpful because you'll be in the best position to assess which bits of REST framework are and aren't easy to understand and work with.

    +

    If you use REST framework, we'd love you to be vocal about your experiences with it - you might consider writing a blog post about using REST framework, or publishing a tutorial about building a project with a particularJjavascript framework. Experiences from beginners can be particularly helpful because you'll be in the best position to assess which bits of REST framework are more difficult to understand and work with.

    Other really great ways you can help move the community forward include helping answer questions on the discussion group, or setting up an email alert on StackOverflow so that you get notified of any new questions with the django-rest-framework tag.

    When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant.

    Code of conduct

    @@ -234,6 +237,8 @@
  • When describing issues try to phrase your ticket in terms of the behavior you think needs changing rather than the code you think need changing.
  • Search the issue list first for related items, and make sure you're running the latest version of REST framework before reporting an issue.
  • If reporting a bug, then try to include a pull request with a failing test case. This will help us quickly identify if there is a valid issue, and make sure that it gets fixed more quickly if there is one.
  • +
  • Feature requests will often be closed with a recommendation that they be implemented outside of the core REST framework library. Keeping new feature requests implemented as third party libraries allows us to keep down the maintainence overhead of REST framework, so that the focus can be on continued stability, bugfixes, and great documentation.
  • +
  • Closing an issue doesn't necessarily mean the end of a discussion. If you believe your issue has been closed incorrectly, explain why and we'll consider if it needs to be reopened.
  • Triaging issues

    Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to

    @@ -242,6 +247,7 @@
  • Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
  • If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
  • If the ticket is a feature request, do you agree with it, and could the feature request instead be implemented as a third party package?
  • +
  • If a ticket hasn't had much activity and it addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
  • Development

    To start developing on Django REST framework, clone the repo:

    @@ -323,6 +329,13 @@ More text... ---
    +

    Third party packages

    +

    New features to REST framework are generally recommended to be implemented as third party libraries that are developed outside of the core framework. Ideally third party libraries should be properly documented and packaged, and made available on PyPI.

    +

    Getting started

    +

    If you have some functionality that you would like to implement as a third party package it's worth contacting the discussion group as others may be willing to get involved. We strongly encourage third party package development and will always try to prioritize time spent helping their development, documentation and packaging.

    +

    We recommend the django-reusable-app template as a good resource for getting up and running with implementing a third party Django package.

    +

    Linking to your package

    +

    Once your package is decently documented and available on PyPI open a pull request or issue, and we'll add a link to it from the main REST framework documentation.

    diff --git a/topics/credits.html b/topics/credits.html index f22ce5026..d789963b7 100644 --- a/topics/credits.html +++ b/topics/credits.html @@ -175,7 +175,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/topics/documenting-your-api.html b/topics/documenting-your-api.html index 22cec3607..1489fb4ec 100644 --- a/topics/documenting-your-api.html +++ b/topics/documenting-your-api.html @@ -176,7 +176,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/topics/release-notes.html b/topics/release-notes.html index 74d4ba186..6a9205663 100644 --- a/topics/release-notes.html +++ b/topics/release-notes.html @@ -184,7 +184,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/topics/rest-framework-2-announcement.html b/topics/rest-framework-2-announcement.html index 829d60fcf..ebee8822b 100644 --- a/topics/rest-framework-2-announcement.html +++ b/topics/rest-framework-2-announcement.html @@ -181,7 +181,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html index 4fd86ecca..176cfbf35 100644 --- a/topics/rest-hypermedia-hateoas.html +++ b/topics/rest-hypermedia-hateoas.html @@ -176,7 +176,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/topics/writable-nested-serializers.html b/topics/writable-nested-serializers.html index f6a426ae2..0a10ce99b 100644 --- a/topics/writable-nested-serializers.html +++ b/topics/writable-nested-serializers.html @@ -174,7 +174,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html index 4daaf9d44..999239029 100644 --- a/tutorial/1-serialization.html +++ b/tutorial/1-serialization.html @@ -183,7 +183,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html index 69d3d3dd0..6b5f67da9 100644 --- a/tutorial/2-requests-and-responses.html +++ b/tutorial/2-requests-and-responses.html @@ -181,7 +181,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html index a802cf736..6a5ca7217 100644 --- a/tutorial/3-class-based-views.html +++ b/tutorial/3-class-based-views.html @@ -176,7 +176,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/4-authentication-and-permissions.html b/tutorial/4-authentication-and-permissions.html index b4b6c57be..6e166c089 100644 --- a/tutorial/4-authentication-and-permissions.html +++ b/tutorial/4-authentication-and-permissions.html @@ -182,7 +182,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html index 7a7f767ef..9222bc2d3 100644 --- a/tutorial/5-relationships-and-hyperlinked-apis.html +++ b/tutorial/5-relationships-and-hyperlinked-apis.html @@ -179,7 +179,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/6-viewsets-and-routers.html b/tutorial/6-viewsets-and-routers.html index 111d699ae..a5287a793 100644 --- a/tutorial/6-viewsets-and-routers.html +++ b/tutorial/6-viewsets-and-routers.html @@ -179,7 +179,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here:

    diff --git a/tutorial/quickstart.html b/tutorial/quickstart.html index 70fef44c3..0dfb8a459 100644 --- a/tutorial/quickstart.html +++ b/tutorial/quickstart.html @@ -179,7 +179,7 @@

    -

    The team behind REST framework are launching a new API service.

    +

    The team behind REST framework is launching a new API service.

    If you want to be first in line when we start issuing invitations, please sign up here: