Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DTW-93 fix table issues #144

Merged
merged 9 commits into from
Jan 25, 2024
Merged

DTW-93 fix table issues #144

merged 9 commits into from
Jan 25, 2024

Conversation

elenaschwan
Copy link
Contributor

Why

We have been seeing issues with the way our tables are formatted, which:

  • make it difficult to edit and review due to lots of styling parameters in the tables
  • means we cannot use partial links, which makes editing more time consuming and difficult, especially if you make changes to headings
  • means formatting to have bold header rows are not correctly displayed throughout the docs

What

Describe the changes you're proposing.

Technical writer support

Do you need a tech writer's support, for example to review your PR?

How to review

Tell reviewers how to assess your changes.

@elenaschwan elenaschwan changed the title Dtw 93 fix table issues DTW-93 fix table issues Jan 3, 2024
@elenaschwan elenaschwan marked this pull request as ready for review January 18, 2024 15:21
@elenaschwan
Copy link
Contributor Author

This PR is also addressing this issue: #78

@elenaschwan elenaschwan mentioned this pull request Jan 24, 2024

If you [requested identity assurance][integrate.choose-level-of-confidence], when you [retrieve user information with `/userinfo`](/integrate-with-integration-environment/authenticate-your-user/#retrieve-user-information), you’ll receive a response containing additional claims (user attributes). You may receive different claims, depending on how your user proved their identity.
If you [requested identity proving][integrate.choose-level-of-confidence], when you [retrieve user information with `/userinfo`][integrate.retrieve-user-info], you’ll receive a response containing additional claims (user attributes). You may receive different claims, depending on how your user proved their identity.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term is "identity proofing", see https://datatracker.ietf.org/doc/html/rfc8485#section-2.1

But I'm not sure this change should be tied up with fixing the tables!

As an aside, it makes slightly more sense to ask for "identity assurance" because RPs don't ask us to necessarily prove someone's identity, they just ask that we have (previously) proven it, and that the account is still secure (so the identity proof is protected with 2 factor auth etc). But "identity proofing" is fine too. "Proving" is just wrong (though frequently used in this programme - wrongly!).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is leftover from merging the changes that came in through the language consistency PR that was merged earlier in the week.

We are aware that the programme has not been using consistent language, but 'proving' is used on GOV.UK to explain the concept (https://www.gov.uk/government/publications/identity-proofing-and-verification-of-an-individual/how-to-prove-and-verify-someones-identity). Hence we decided, that we will use 'proving' here, until we have got consensus on what language we want/should use. These discussions are being set up at the moment, and once that's concluded we will do a second iteration and update the wording.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word 'proving' isn't on that page at all? "Proving/prove" is the verb, but the noun for the process is "proofing". This is a grammar thing, I don't know why it is that way. But if you search "identity proving" on Google or something, you will mainly get non-relevant results for what we do, whereas "identity proofing" will get you information about what we do in GOV.UK One Login.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title talks about 'how to prove an identity', and since proving is the present participle of to prove, we are staying in line with how it is referred to there. Also, this is one of the recommended ways of talking about it in our UCD DI style guide.

We made this decision together with the technical architects of the Adoption pod, knowing that this will need re-discussing. I don't think, however, this is the right forum. I will raise an issue in the repo to pick this separately.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, as a verb like in that title it definitely makes sense. Agree this PR is not the place for it, better to separate it out.

@elenaschwan elenaschwan merged commit e3c75b7 into main Jan 25, 2024
1 check passed
@elenaschwan elenaschwan deleted the DTW-93-fix-table-issues branch January 25, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants