PP-12251: Adds some signposting to some API-only features #956
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asimms41
reviewed
Mar 13, 2024
Co-authored-by: asimms41 <[email protected]>
Co-authored-by: asimms41 <[email protected]>
charleemg
reviewed
Mar 18, 2024
| @@ -9,6 +9,8 @@ weight: 2100 | |||
|
|
|||
| This section tells you how to take a payment using the GOV.UK Pay API. | |||
|
|
|||
| If you want to take payments using a no-code solution instead, you can use [payment links](https://www.payments.service.gov.uk/govuk-payment-pages/). | |||
There was a problem hiding this comment.
what is the purpose of "instead" here? I am wondering if it works the same just with "If you want to take payments using a no-code solution, you can use..."
There was a problem hiding this comment.
Good point. Services can use both - I'll adjust.
charleemg
reviewed
Mar 18, 2024
| @@ -19,6 +21,8 @@ Your service has [additional responsibilities when taking recurring payments](/r | |||
| * telling users when you’re going to take or change payments | |||
| * letting users amend their recurring payments | |||
|
|
|||
| It would be helpful to familiarise yourself [the standard GOV.UK Pay payment flow](/payment_flow) before reading about recurring payments. | |||
|
|
|||
| This section outlines the recurring payment flow, your responsibilities, and how to set up and use agreements to take recurring payments. | |||
There was a problem hiding this comment.
"This section explains"? I think "outlines" is a bit of a policy word, dangerously close to "sets out" :)
There was a problem hiding this comment.
'explains' is clearer English - good spot!
charleemg
reviewed
Mar 18, 2024
charleemg
approved these changes
Mar 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
A lot of the pages in the tech docs have pre-requisites that we don’t really spell out. For example, ‘Take recurring payments’ makes more sense if readers have an understanding of how standard payments work. Similarly, ‘Take a payment’ requires users to have some technical knowledge to understand how APIs work.
Changes proposed in this pull request
This PR:
Guidance to review