From 98f51d81749a753f433d02be060c9227023e5416 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Tue, 20 Aug 2019 12:03:42 +0100 Subject: [PATCH 01/10] Update content --- app/templates/views/documentation.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index aef5a09d0..d3c7032fa 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -7,9 +7,9 @@ {% block content_column_content %}

Documentation

-

Use the GOV.UK Notify API to send messages automatically.

+

This documentation is for developers who want to integrate the GOV.UK Notify API with a web application or back office system.

Clients

-

Choose a client to integrate our API with your web application or back-office system. Links to documentation open in a new tab.

+

Links to documentation open in a new tab.

- +

You can work directly with the API, but this may be complicated to set up. Contact us for more information.

{% endblock %} From 39461b369d66bbb2e79c9c461a8512a2066f79cc Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Tue, 20 Aug 2019 14:51:54 +0100 Subject: [PATCH 02/10] Add details about timings and direct integration Outline how long it can take to integrate using the client documentation. Add more detail about how to integrate directly with the API. --- app/templates/views/documentation.html | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index d3c7032fa..8a9fc6976 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -22,5 +22,9 @@
  • {{ label }}
    • {% endfor %} -

    You can work directly with the API, but this may be complicated to set up. Contact us for more information.

    +

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration might take a couple of days.

    +

    Integrating directly with the API

    +

    You can integrate directly with the Notify API.

    +

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    +

    Reading the client documentation will help you to do this.

    {% endblock %} From 73415f7a0887893db04388218d1e8e794be429dc Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Tue, 20 Aug 2019 15:07:48 +0100 Subject: [PATCH 03/10] Update Integrating directly with the API content Move the line about reading client documentation. --- app/templates/views/documentation.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 8a9fc6976..811b1f219 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -24,7 +24,6 @@

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration might take a couple of days.

    Integrating directly with the API

    -

    You can integrate directly with the Notify API.

    +

    You can integrate directly with the Notify API. Reading the client documentation will help you to do this.

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    -

    Reading the client documentation will help you to do this.

    {% endblock %} From 3dfa6e06cccb1b4fc6e79af470ae704aff55281c Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Tue, 20 Aug 2019 17:06:01 +0100 Subject: [PATCH 04/10] Update client documentation content --- app/templates/views/documentation.html | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 811b1f219..7d25b511a 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -24,6 +24,11 @@

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration might take a couple of days.

    Integrating directly with the API

    -

    You can integrate directly with the Notify API. Reading the client documentation will help you to do this.

    +

    You can integrate directly with the Notify API.

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    +

    You should also read the client documentation to understand:

    +
      +
    • what the API client does
      • +
    • what development work you'll need to do
      • +
    {% endblock %} From 12f0c1e0ffaf61097857afa985f92bb7fcbbc2d7 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 09:56:27 +0100 Subject: [PATCH 05/10] Update timings and direct integration content --- app/templates/views/documentation.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 7d25b511a..7e875be30 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -22,13 +22,13 @@
  • {{ label }}
    • {% endfor %} -

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration might take a couple of days.

    +

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you're using.

    Integrating directly with the API

    -

    You can integrate directly with the Notify API.

    -

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    -

    You should also read the client documentation to understand:

    +

    We recommend using our client documentation rather than integrating directly with the API.

    +

    There's no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    • what the API client does
    • what development work you'll need to do
    +

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    {% endblock %} From af7222de1dd615672f708d992e17bd6cb888ef1d Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 10:15:03 +0100 Subject: [PATCH 06/10] Update app/templates/views/documentation.html Co-Authored-By: Chris Hill-Scott --- app/templates/views/documentation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 7e875be30..34f558a93 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -22,7 +22,7 @@
  • {{ label }}
    • {% endfor %} -

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you're using.

    +

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

    Integrating directly with the API

    We recommend using our client documentation rather than integrating directly with the API.

    There's no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    From 6c9f6463c38130508e13a406234e19d1c1618e15 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 10:15:10 +0100 Subject: [PATCH 07/10] Update app/templates/views/documentation.html Co-Authored-By: Chris Hill-Scott --- app/templates/views/documentation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 34f558a93..8ffdafbdf 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -25,7 +25,7 @@

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

    Integrating directly with the API

    We recommend using our client documentation rather than integrating directly with the API.

    -

    There's no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    +

    There’s no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    • what the API client does
    • what development work you'll need to do
      • From ff663ed172d332b7c42f4f2cabce11ade0cbdb14 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 10:15:17 +0100 Subject: [PATCH 08/10] Update app/templates/views/documentation.html Co-Authored-By: Chris Hill-Scott --- app/templates/views/documentation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 8ffdafbdf..47e92b61b 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -30,5 +30,5 @@
    • what the API client does
    • what development work you'll need to do
    -

    To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    +

    To send a message you’ll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    {% endblock %} From c05969e23047b3cb8e32f368b3e823229e52e27a Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 10:15:27 +0100 Subject: [PATCH 09/10] Update app/templates/views/documentation.html Co-Authored-By: Chris Hill-Scott --- app/templates/views/documentation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 47e92b61b..8032e5e46 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -28,7 +28,7 @@

    There’s no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    • what the API client does
      • -
    • what development work you'll need to do
      • +
    • what development work you’ll need to do

    To send a message you’ll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

    {% endblock %} From 8989f5a93b5eb53a2168200dd867122ddf617cd0 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Wed, 21 Aug 2019 10:17:36 +0100 Subject: [PATCH 10/10] Update 'client libraries' --- app/templates/views/documentation.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/templates/views/documentation.html b/app/templates/views/documentation.html index 8032e5e46..d4bfdd1c7 100644 --- a/app/templates/views/documentation.html +++ b/app/templates/views/documentation.html @@ -8,7 +8,7 @@

    Documentation

    This documentation is for developers who want to integrate the GOV.UK Notify API with a web application or back office system.

    -

    Clients

    +

    Client libraries

    Links to documentation open in a new tab.

      {% for key, label in [ @@ -24,8 +24,8 @@

    A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

    Integrating directly with the API

    -

    We recommend using our client documentation rather than integrating directly with the API.

    -

    There’s no documentation for using the API in this way. You'll still need to read the client documentation to understand:

    +

    We recommend using the client libraries rather than integrating directly with the API.

    +

    There’s no documentation for using the API in this way. You’ll still need to read the client documentation to understand:

    • what the API client does
    • what development work you’ll need to do