From bf96add452b3c5f735de744e5796da00c6466094 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Fri, 11 Oct 2019 03:07:27 -0700 Subject: [PATCH 1/3] Fix funding link in 3.10 announcement --- docs/community/3.10-announcement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/3.10-announcement.md b/docs/community/3.10-announcement.md index 065dd3480a..257ae1c2f0 100644 --- a/docs/community/3.10-announcement.md +++ b/docs/community/3.10-announcement.md @@ -144,4 +144,4 @@ continued development by **[signing up for a paid plan][funding]**. [legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/master/docs/coreapi/index.md [sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors -[funding]: community/funding.md +[funding]: funding.md From 11f158f2bcad9e8e46ab869faf96fbaab07ffbb4 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Fri, 11 Oct 2019 03:10:04 -0700 Subject: [PATCH 2/3] Fixup links in "Documenting your API" topic --- docs/topics/documenting-your-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/documenting-your-api.md b/docs/topics/documenting-your-api.md index cf3977d902..f0862272fd 100644 --- a/docs/topics/documenting-your-api.md +++ b/docs/topics/documenting-your-api.md @@ -266,9 +266,9 @@ To implement a hypermedia API you'll need to decide on an appropriate media type [image-django-rest-swagger]: ../img/django-rest-swagger.png [image-apiary]: ../img/apiary.png [image-self-describing-api]: ../img/self-describing.png -[metadata-docs]: ../api-guide/metadata/ +[metadata-docs]: ../api-guide/metadata.md -[schemas-examples]: ../api-guide/schemas/#examples +[schemas-examples]: ../api-guide/schemas.md#examples [swagger-ui]: https://swagger.io/tools/swagger-ui/ [redoc]: https://github.com/Rebilly/ReDoc From 636d22b356093f25af00c1300833b98ab4b9663f Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Fri, 11 Oct 2019 03:10:39 -0700 Subject: [PATCH 3/3] Organize links in "Documenting your API" topic --- docs/topics/documenting-your-api.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/topics/documenting-your-api.md b/docs/topics/documenting-your-api.md index f0862272fd..05d8d99161 100644 --- a/docs/topics/documenting-your-api.md +++ b/docs/topics/documenting-your-api.md @@ -253,22 +253,23 @@ 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]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven -[drf-yasg]: https://github.com/axnsan12/drf-yasg/ -[image-drf-yasg]: ../img/drf-yasg.png -[drfautodocs-repo]: https://github.com/iMakedonsky/drf-autodocs -[django-rest-swagger]: https://github.com/marcgibbons/django-rest-swagger -[swagger]: https://swagger.io/ -[open-api]: https://openapis.org/ -[rest-framework-docs]: https://github.com/marcgibbons/django-rest-framework-docs -[apiary]: https://apiary.io/ -[markdown]: https://daringfireball.net/projects/markdown/syntax + [hypermedia-docs]: rest-hypermedia-hateoas.md -[image-django-rest-swagger]: ../img/django-rest-swagger.png +[metadata-docs]: ../api-guide/metadata.md +[schemas-examples]: ../api-guide/schemas.md#examples + [image-apiary]: ../img/apiary.png +[image-django-rest-swagger]: ../img/django-rest-swagger.png +[image-drf-yasg]: ../img/drf-yasg.png [image-self-describing-api]: ../img/self-describing.png -[metadata-docs]: ../api-guide/metadata.md -[schemas-examples]: ../api-guide/schemas.md#examples -[swagger-ui]: https://swagger.io/tools/swagger-ui/ +[apiary]: https://apiary.io/ +[django-rest-swagger]: https://github.com/marcgibbons/django-rest-swagger +[drfautodocs-repo]: https://github.com/iMakedonsky/drf-autodocs +[drf-yasg]: https://github.com/axnsan12/drf-yasg/ +[markdown]: https://daringfireball.net/projects/markdown/syntax +[open-api]: https://openapis.org/ [redoc]: https://github.com/Rebilly/ReDoc - +[rest-framework-docs]: https://github.com/marcgibbons/django-rest-framework-docs +[swagger]: https://swagger.io/ +[swagger-ui]: https://swagger.io/tools/swagger-ui/