From 9defb5ee9f0090f98fa579f1e74b7dfdd6138744 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Nov 2014 11:01:21 +0000 Subject: [PATCH] Update documentation --- topics/contributing/index.html | 24 ---- topics/kickstarter-announcement/index.html | 142 ++++++++++----------- tutorial/1-serialization/index.html | 4 +- 3 files changed, 73 insertions(+), 97 deletions(-) diff --git a/topics/contributing/index.html b/topics/contributing/index.html index 9e25b460f..690b9dc5c 100644 --- a/topics/contributing/index.html +++ b/topics/contributing/index.html @@ -404,22 +404,6 @@ -
  • - Third party packages -
    • - - -
  • - Getting started -
    • - -
  • - Linking to your package -
    • - - - - @@ -568,14 +552,6 @@ 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. You can add your package under Third party packages of the API Guide section that best applies, like Authentication or Permissions. You can also link your package under the Third Party Resources section.

    -

    We also suggest adding it to the REST Framework grid on Django Packages.

    diff --git a/topics/kickstarter-announcement/index.html b/topics/kickstarter-announcement/index.html index b9c7e34f7..e27aafc3d 100644 --- a/topics/kickstarter-announcement/index.html +++ b/topics/kickstarter-announcement/index.html @@ -391,20 +391,20 @@

    Platinum sponsors

    Our platinum sponsors have each made a hugely substantial contribution to the future development of Django REST framework, and I simply can't thank them enough.

    @@ -413,31 +413,31 @@

    Gold sponsors

    Our gold sponsors include companies large and small. Many thanks for their significant funding of the project and their commitment to sustainable open-source development.

    @@ -447,41 +447,41 @@

    Silver sponsors

    The serious financial contribution that our silver sponsors have made is very much appreciated. I'd like to say a particular thank you to individuals who have choosen to privately support the project at this level.

    diff --git a/tutorial/1-serialization/index.html b/tutorial/1-serialization/index.html index ae558ebcd..acdb0893b 100644 --- a/tutorial/1-serialization/index.html +++ b/tutorial/1-serialization/index.html @@ -563,7 +563,7 @@ Open the file snippets/serializers.py again, and edit the Sni model = Snippet fields = ('id', 'title', 'code', 'linenos', 'language', 'style') -

    Once nice property that serializers have is that you can inspect all the fields an serializer instance, by printing it's representation. Open the Django shell with python manange.py shell, then try the following:

    +

    One nice property that serializers have is that you can inspect all the fields in a serializer instance, by printing it's representation. Open the Django shell with python manange.py shell, then try the following:

    >>> from snippets.serializers import SnippetSerializer
 >>> serializer = SnippetSerializer()
 >>> print repr(serializer)  # In python 3 use `print(repr(serializer))`
@@ -575,7 +575,7 @@ SnippetSerializer():
     language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
     style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...
    -

    It's important to remember that ModelSerializer classes don't do anything particularly magically, they are simply a shortcut to creating a serializer class with:

    +

    It's important to remember that ModelSerializer classes don't do anything particularly magical, they are simply a shortcut for creating serializer classes: