Merge pull request #3762 from ekonstantinidis/add-drf-docs

Add DRF docs to "Documenting your API"

docs/topics/documenting-your-api.md

@@ -12,23 +12,29 @@ The most common way to document Web APIs today is to produce documentation that
 
 ---
 
-#### Django REST Swagger
+#### DRF Docs
 
-Marc Gibbons' [Django REST Swagger][django-rest-swagger] integrates REST framework with the [Swagger][swagger] API documentation tool.  The package produces well presented API documentation, and includes interactive tools for testing API endpoints.
+[DRF Docs][drfdocs-repo] allows you to document Web APIs made with Django REST Framework and it is authored by Emmanouil Konstantinidis. It's made to work out of the box and its setup should not take more than a couple of minutes. Complete documentation can be found on the [website][drfdocs-website] while there is also a [demo][drfdocs-demo] available for people to see what it looks like.
 
-The package is fully documented, well supported, and comes highly recommended.
+Features include customizing the template with your branding, settings for hiding the docs depending on the environment and more.
 
-Django REST Swagger supports REST framework versions 2.3 and above.
+Both this package and Django REST Swagger are fully documented, well supported, and come highly recommended.
 
-![Screenshot - Django REST Swagger][image-django-rest-swagger]
+![Screenshot - DRF docs][image-drf-docs]
 
 ---
 
-#### REST Framework Docs
+#### Django REST Swagger
 
-The [REST Framework Docs][rest-framework-docs] package is an earlier project, also by Marc Gibbons, that offers clean, simple autogenerated documentation for your API.
+Marc Gibbons' [Django REST Swagger][django-rest-swagger] integrates REST framework with the [Swagger][swagger] API documentation tool.  The package produces well presented API documentation, and includes interactive tools for testing API endpoints.
 
-![Screenshot - REST Framework Docs][image-rest-framework-docs]
+Django REST Swagger supports REST framework versions 2.3 and above.
+
+Mark is also the author of the [REST Framework Docs][rest-framework-docs] package which offers clean, simple autogenerated documentation for your API but is deprecated and has moved to Django REST Swagger.
+
+Both this package and DRF docs are fully documented, well supported, and come highly recommended.
+
+![Screenshot - Django REST Swagger][image-django-rest-swagger]
 
 ---
 
@@ -100,13 +106,16 @@ In this approach, rather than documenting the available API endpoints up front,
 To implement a hypermedia API you'll need to decide on an appropriate media type for the API, and implement a custom renderer and parser for that media type.  The [REST, Hypermedia & HATEOAS][hypermedia-docs] section of the documentation includes pointers to background reading, as well as links to various hypermedia formats.
 
 [cite]: http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
+[drfdocs-repo]: https://github.com/ekonstantinidis/django-rest-framework-docs
+[drfdocs-website]: http://www.drfdocs.com/
+[drfdocs-demo]: http://demo.drfdocs.com/
 [django-rest-swagger]: https://github.com/marcgibbons/django-rest-swagger
 [swagger]: https://developers.helloreverb.com/swagger/
 [rest-framework-docs]: https://github.com/marcgibbons/django-rest-framework-docs
 [apiary]: http://apiary.io/
 [markdown]: http://daringfireball.net/projects/markdown/
 [hypermedia-docs]: rest-hypermedia-hateoas.md
+[image-drf-docs]: ../img/drfdocs.png
 [image-django-rest-swagger]: ../img/django-rest-swagger.png
-[image-rest-framework-docs]: ../img/rest-framework-docs.png
 [image-apiary]: ../img/apiary.png
 [image-self-describing-api]: ../img/self-describing.png