From c678a1f118ea65fc1d13c40ef1a083577fdd5381 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 18 Dec 2014 13:49:50 +0000 Subject: Update documentation --- api-guide/authentication/index.html | 4 + api-guide/content-negotiation/index.html | 4 + api-guide/exceptions/index.html | 4 + api-guide/fields/index.html | 4 + api-guide/filtering/index.html | 4 + api-guide/format-suffixes/index.html | 4 + api-guide/generic-views/index.html | 4 + api-guide/pagination/index.html | 4 + api-guide/parsers/index.html | 4 + api-guide/permissions/index.html | 4 + api-guide/relations/index.html | 4 + api-guide/renderers/index.html | 4 + api-guide/requests/index.html | 4 + api-guide/responses/index.html | 4 + api-guide/reverse/index.html | 4 + api-guide/routers/index.html | 4 + api-guide/serializers/index.html | 4 + api-guide/settings/index.html | 4 + api-guide/status-codes/index.html | 4 + api-guide/testing/index.html | 4 + api-guide/throttling/index.html | 4 + api-guide/validators/index.html | 4 + api-guide/views/index.html | 4 + api-guide/viewsets/index.html | 4 + index.html | 5 + topics/2.2-announcement/index.html | 4 + topics/2.3-announcement/index.html | 4 + topics/2.4-announcement/index.html | 4 + topics/3.0-announcement/index.html | 4 + topics/ajax-csrf-cors/index.html | 4 + topics/browsable-api/index.html | 4 + topics/browser-enhancements/index.html | 4 + topics/contributing/index.html | 6 +- topics/credits/index.html | 4 + topics/documenting-your-api/index.html | 4 + topics/kickstarter-announcement/index.html | 4 + topics/project-management/index.html | 537 +++++++++++++++++++++ topics/release-notes/index.html | 4 + topics/rest-framework-2-announcement/index.html | 6 +- topics/rest-hypermedia-hateoas/index.html | 4 + topics/third-party-resources/index.html | 4 + tutorial/1-serialization/index.html | 4 + tutorial/2-requests-and-responses/index.html | 4 + tutorial/3-class-based-views/index.html | 4 + .../4-authentication-and-permissions/index.html | 4 + .../index.html | 4 + tutorial/6-viewsets-and-routers/index.html | 8 +- tutorial/quickstart/index.html | 4 + 48 files changed, 730 insertions(+), 4 deletions(-) create mode 100644 topics/project-management/index.html diff --git a/api-guide/authentication/index.html b/api-guide/authentication/index.html index c30a7aa4..b2b68960 100644 --- a/api-guide/authentication/index.html +++ b/api-guide/authentication/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/content-negotiation/index.html b/api-guide/content-negotiation/index.html index 46a240ba..9ae7563b 100644 --- a/api-guide/content-negotiation/index.html +++ b/api-guide/content-negotiation/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/exceptions/index.html b/api-guide/exceptions/index.html index f184e9ba..6a6551ec 100644 --- a/api-guide/exceptions/index.html +++ b/api-guide/exceptions/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/fields/index.html b/api-guide/fields/index.html index c2575416..29c302cd 100644 --- a/api-guide/fields/index.html +++ b/api-guide/fields/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/filtering/index.html b/api-guide/filtering/index.html index a2f9548c..185b44d3 100644 --- a/api-guide/filtering/index.html +++ b/api-guide/filtering/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/format-suffixes/index.html b/api-guide/format-suffixes/index.html index 5d0a93fb..facede7b 100644 --- a/api-guide/format-suffixes/index.html +++ b/api-guide/format-suffixes/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/generic-views/index.html b/api-guide/generic-views/index.html index 100ea700..62b833d5 100644 --- a/api-guide/generic-views/index.html +++ b/api-guide/generic-views/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/pagination/index.html b/api-guide/pagination/index.html index 870035c2..11ef3d27 100644 --- a/api-guide/pagination/index.html +++ b/api-guide/pagination/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/parsers/index.html b/api-guide/parsers/index.html index 39b505d7..8e362b95 100644 --- a/api-guide/parsers/index.html +++ b/api-guide/parsers/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/permissions/index.html b/api-guide/permissions/index.html index 893d3957..45efddf9 100644 --- a/api-guide/permissions/index.html +++ b/api-guide/permissions/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/relations/index.html b/api-guide/relations/index.html index 2c4fe9b6..239eec48 100644 --- a/api-guide/relations/index.html +++ b/api-guide/relations/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/renderers/index.html b/api-guide/renderers/index.html index 86223be3..7c9ae852 100644 --- a/api-guide/renderers/index.html +++ b/api-guide/renderers/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/requests/index.html b/api-guide/requests/index.html index 679b036b..88833ed5 100644 --- a/api-guide/requests/index.html +++ b/api-guide/requests/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/responses/index.html b/api-guide/responses/index.html index be8cca9c..8ca4cfc0 100644 --- a/api-guide/responses/index.html +++ b/api-guide/responses/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/reverse/index.html b/api-guide/reverse/index.html index 08399151..f15c35d4 100644 --- a/api-guide/reverse/index.html +++ b/api-guide/reverse/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/routers/index.html b/api-guide/routers/index.html index e204b48e..bc95fe9d 100644 --- a/api-guide/routers/index.html +++ b/api-guide/routers/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/serializers/index.html b/api-guide/serializers/index.html index 4c03b25f..13bc661d 100644 --- a/api-guide/serializers/index.html +++ b/api-guide/serializers/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/settings/index.html b/api-guide/settings/index.html index 654807d8..94050822 100644 --- a/api-guide/settings/index.html +++ b/api-guide/settings/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/status-codes/index.html b/api-guide/status-codes/index.html index d9ff28cb..e2138d5e 100644 --- a/api-guide/status-codes/index.html +++ b/api-guide/status-codes/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/testing/index.html b/api-guide/testing/index.html index f456ac21..f3b6d005 100644 --- a/api-guide/testing/index.html +++ b/api-guide/testing/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/throttling/index.html b/api-guide/throttling/index.html index f8a66679..5b8c6df0 100644 --- a/api-guide/throttling/index.html +++ b/api-guide/throttling/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/validators/index.html b/api-guide/validators/index.html index 70b680c1..5ae6f03b 100644 --- a/api-guide/validators/index.html +++ b/api-guide/validators/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/views/index.html b/api-guide/views/index.html index 1b832edb..231854d9 100644 --- a/api-guide/views/index.html +++ b/api-guide/views/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/api-guide/viewsets/index.html b/api-guide/viewsets/index.html index 0ecde797..a0d4251e 100644 --- a/api-guide/viewsets/index.html +++ b/api-guide/viewsets/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/index.html b/index.html index 6ca26a38..59b81d21 100644 --- a/index.html +++ b/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • @@ -622,6 +626,7 @@ urlpatterns = [
  • REST, Hypermedia & HATEOAS
  • Third Party Resources
  • Contributing to REST framework
    • +
  • Project management
  • 2.0 Announcement
  • 2.2 Announcement
  • 2.3 Announcement
    • diff --git a/topics/2.2-announcement/index.html b/topics/2.2-announcement/index.html index eaa1db10..d25fb362 100644 --- a/topics/2.2-announcement/index.html +++ b/topics/2.2-announcement/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/2.3-announcement/index.html b/topics/2.3-announcement/index.html index 881ffff6..12dc5ba1 100644 --- a/topics/2.3-announcement/index.html +++ b/topics/2.3-announcement/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/2.4-announcement/index.html b/topics/2.4-announcement/index.html index c811dc5c..fa96619a 100644 --- a/topics/2.4-announcement/index.html +++ b/topics/2.4-announcement/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/3.0-announcement/index.html b/topics/3.0-announcement/index.html index addb47cb..83dab0a8 100644 --- a/topics/3.0-announcement/index.html +++ b/topics/3.0-announcement/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/ajax-csrf-cors/index.html b/topics/ajax-csrf-cors/index.html index f9bb6392..0e22734f 100644 --- a/topics/ajax-csrf-cors/index.html +++ b/topics/ajax-csrf-cors/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/browsable-api/index.html b/topics/browsable-api/index.html index 2b3ed258..f82c984d 100644 --- a/topics/browsable-api/index.html +++ b/topics/browsable-api/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/browser-enhancements/index.html b/topics/browser-enhancements/index.html index 5f6e1ba7..30c36d72 100644 --- a/topics/browser-enhancements/index.html +++ b/topics/browser-enhancements/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/contributing/index.html b/topics/contributing/index.html index 8f259f52..62d0ff39 100644 --- a/topics/contributing/index.html +++ b/topics/contributing/index.html @@ -62,7 +62,7 @@
    GitHub - Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/credits/index.html b/topics/credits/index.html index 40c3ee52..c20448dd 100644 --- a/topics/credits/index.html +++ b/topics/credits/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/documenting-your-api/index.html b/topics/documenting-your-api/index.html index ae50add0..25c6210c 100644 --- a/topics/documenting-your-api/index.html +++ b/topics/documenting-your-api/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/kickstarter-announcement/index.html b/topics/kickstarter-announcement/index.html index 109fa946..f8bc71e0 100644 --- a/topics/kickstarter-announcement/index.html +++ b/topics/kickstarter-announcement/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/project-management/index.html b/topics/project-management/index.html new file mode 100644 index 00000000..036e23a0 --- /dev/null +++ b/topics/project-management/index.html @@ -0,0 +1,537 @@ + + + + + + + Project management - Django REST framework + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + GitHub + + + Search + + + + + + Django REST framework +
    + + + + +
    + + +
    +
    +
    + +
    +
    + + + + +
    + +
    + +
    + + +
    +
    + +
    + + +

    Project management

    +
    +

    "No one can whistle a symphony; it takes a whole orchestra to play it"

    +

    — Halford E. Luccock

    +
    +

    This document outlines our project management processes for REST framework.

    +

    The aim is to ensure that the project has a high +"bus factor", and can continue to remain well supported for the foreseeable future. Suggestions for improvements to our process are welcome.

    +
    +

    Maintenance team

    +

    We have a quarterly maintenance cycle where new members may join the maintenance team. We currently cap the size of the team at 5 members, and may encourage folks to step out of the team for a cycle to allow new members to participate.

    +

    Current team

    +

    The maintenance team for Q1 2015:

    + +

    Maintenance cycles

    +

    Each maintenance cycle is initiated by an issue being opened with the Process label.

    +
      +
    • To be considered for a maintainer role simply comment against the issue.
      • +
    • Existing members must explicitly opt-in to the next cycle by check-marking their name.
      • +
    • The final decision on the incoming team will be made by @tomchristie.
      • +
    +

    Members of the maintenance team will be added as collaborators to the repository.

    +

    The following template should be used for the description of the issue, and serves as the formal process for selecting the team.

    +
    This issue is for determining the maintenance team for the *** period.
+
+Please see the [Project management](http://www.django-rest-framework.org/topics/project-management/) section of our documentation for more details.
+
+---
+
+#### Renewing existing members.
+
+The following people are the current maintenance team. Please checkmark your name if you wish to continue to have write permission on the repository for the *** period.
+
+- [ ] @***
+- [ ] @***
+- [ ] @***
+- [ ] @***
+- [ ] @***
+
+---
+
+#### New members.
+
+If you wish to be considered for this or a future date, please comment against this or subsequent issues.
+
    +

    Responsibilities of team members

    +

    Team members have the following responsibilities.

    +
      +
    • Add triage labels and milestones to tickets.
      • +
    • Close invalid or resolved tickets.
      • +
    • Merge finalized pull requests.
      • +
    • Build and deploy the documentation, using mkdocs gh-deploy.
      • +
    +

    Further notes for maintainers:

    +
      +
    • Code changes should come in the form of a pull request - do not push directly to master.
      • +
    • Maintainers should typically not merge their own pull requests.
      • +
    • Each issue/pull request should have exactly one label once triaged.
      • +
    • Search for un-triaged issues with is:open no:label.
      • +
    +

    It should be noted that participating actively in the REST framework project clearly does not require being part of the maintenance team. Almost every import part of issue triage and project improvement can be actively worked on regardless of your collaborator status on the repository.

    +
    +

    Release process

    +

    The release manager is selected on every quarterly maintenance cycle.

    +
      +
    • The manager should be selected by @tomchristie.
      • +
    • The manager will then have the maintainer role added to PyPI package.
      • +
    • The previous manager will then have the maintainer role removed from the PyPI package.
      • +
    +

    Our PyPI releases will be handled by either the current release manager, or by @tomchristie. Every release should have an open issue tagged with the Release label and marked against the appropriate milestone.

    +

    The following template should be used for the description of the issue, and serves as a release checklist.

    +
    Release manager is @***.
+Pull request is #***.
+
+Checklist:
+
+- [ ] Create pull request for [release notes](https://github.com/tomchristie/django-rest-framework/blob/master/docs/topics/release-notes.md) based on the [*.*.* milestone](https://github.com/tomchristie/django-rest-framework/milestones/***).
+- [ ] Ensure the pull request increments the version to `*.*.*` in [`restframework/__init__.py`](https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/__init__.py).
+- [ ] Confirm with @tomchristie that release is finalized and ready to go.
+- [ ] Ensure that release date is included in pull request.
+- [ ] Merge the release pull request.
+- [ ] Push the package to PyPI with `./setup.py publish`.
+- [ ] Tag the release, with `git tag -a *.*.* -m 'version *.*.*'; git push --tags`.
+- [ ] Deploy the documentation with `mkdocs gh-deploy`.
+- [ ] Make a release announcement on the [discussion group](https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework).
+- [ ] Make a release announcement on twitter.
+- [ ] Close the milestone on GitHub.
+
    +

    When pushing the release to PyPI ensure that your environment has been installed from our development requirement.txt, so that documentation and PyPI installs are consistently being built against a pinned set of packages.

    +
    +

    Project ownership

    +

    The PyPI package is owned by @tomchristie. As a backup @j4mie also has ownership of the package.

    +

    If @tomchristie ceases to participate in the project then @j4mie has responsibility for handing over ownership duties.

    +

    Outstanding management & ownership issues

    +

    The following issues still need to be addressed:

    + + +
    + +
    + +
    + +
    + +
    +
    + + +
    +

    Documentation built with MkDocs. +

    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/topics/release-notes/index.html b/topics/release-notes/index.html index ea2ead2f..a8d74ed8 100644 --- a/topics/release-notes/index.html +++ b/topics/release-notes/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/rest-framework-2-announcement/index.html b/topics/rest-framework-2-announcement/index.html index f849c7cc..7047aa7c 100644 --- a/topics/rest-framework-2-announcement/index.html +++ b/topics/rest-framework-2-announcement/index.html @@ -65,7 +65,7 @@ - Search @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/rest-hypermedia-hateoas/index.html b/topics/rest-hypermedia-hateoas/index.html index 6dd2343a..c5171cc0 100644 --- a/topics/rest-hypermedia-hateoas/index.html +++ b/topics/rest-hypermedia-hateoas/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/topics/third-party-resources/index.html b/topics/third-party-resources/index.html index c2d6186e..db4aa07f 100644 --- a/topics/third-party-resources/index.html +++ b/topics/third-party-resources/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/1-serialization/index.html b/tutorial/1-serialization/index.html index 0561fab1..7cb478bd 100644 --- a/tutorial/1-serialization/index.html +++ b/tutorial/1-serialization/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/2-requests-and-responses/index.html b/tutorial/2-requests-and-responses/index.html index e9436d2a..f117a9d3 100644 --- a/tutorial/2-requests-and-responses/index.html +++ b/tutorial/2-requests-and-responses/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/3-class-based-views/index.html b/tutorial/3-class-based-views/index.html index cf7be3ae..6533945d 100644 --- a/tutorial/3-class-based-views/index.html +++ b/tutorial/3-class-based-views/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/4-authentication-and-permissions/index.html b/tutorial/4-authentication-and-permissions/index.html index f4661bde..21e181c5 100644 --- a/tutorial/4-authentication-and-permissions/index.html +++ b/tutorial/4-authentication-and-permissions/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/5-relationships-and-hyperlinked-apis/index.html b/tutorial/5-relationships-and-hyperlinked-apis/index.html index 51a66e92..e552c6e4 100644 --- a/tutorial/5-relationships-and-hyperlinked-apis/index.html +++ b/tutorial/5-relationships-and-hyperlinked-apis/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • diff --git a/tutorial/6-viewsets-and-routers/index.html b/tutorial/6-viewsets-and-routers/index.html index 04071f9e..03839e8d 100644 --- a/tutorial/6-viewsets-and-routers/index.html +++ b/tutorial/6-viewsets-and-routers/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • @@ -423,8 +427,8 @@ class SnippetViewSet(viewsets.ModelViewSet): snippet = self.get_object() return Response(snippet.highlighted) - def pre_save(self, obj): - obj.owner = self.request.user + def perform_create(self, serializer): + serializer.save(owner=self.request.user)

    This time we've used the ModelViewSet class in order to get the complete set of default read and write operations.

    Notice that we've also used the @detail_route decorator to create a custom action, named highlight. This decorator can be used to add any custom endpoints that don't fit into the standard create/update/delete style.

    diff --git a/tutorial/quickstart/index.html b/tutorial/quickstart/index.html index b81e1dc4..0c593f47 100644 --- a/tutorial/quickstart/index.html +++ b/tutorial/quickstart/index.html @@ -251,6 +251,10 @@ Contributing to REST framework +
  • + Project management +
    • +
  • 2.0 Announcement
    • -- cgit v1.2.3