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

Review page - Real world identifiers #530

Closed
kathryn-ods opened this issue Jan 22, 2024 · 8 comments · Fixed by #679
Closed

Review page - Real world identifiers #530

kathryn-ods opened this issue Jan 22, 2024 · 8 comments · Fixed by #679
Assignees

Comments

@kathryn-ods
Copy link
Contributor

kathryn-ods commented Jan 22, 2024

Review of https://standard.openownership.org/en/latest/schema/guidance/identifiers.html

  • remove information that is not relevant to this section/repeated elsewhere
  • edit in line with style guide
@kd-ods
Copy link
Collaborator

kd-ods commented Jan 23, 2024

@kathryn-ods - I went to review the PR #531, and I've realised that ideally we need to review the content of this Real World Identifiers docs page, alongside the description fields of the Identifier object (and the intro text on the reference.rst docs page).

And there's this feedback from tiredpixel to consider as we do this work.

We should consider whether a primary aim with editing a page like this is to bring into the schema (and onto the reference page) as much normative content as possible. If that's a principle we should follow, then we should note it in the handbook too.

I realise that all that potentially widens the scope of this ticket. What do you think?

@kathryn-ods
Copy link
Contributor Author

Yes agreed there's some bigger picture things to consider here around identifiers.

We should consider whether a primary aim with editing a page like this is to bring into the schema (and onto the reference page) as much normative content as possible. If that's a principle we should follow, then we should note it in the handbook too.

I am generally in favour of doing this. On the current page there's a breakdown of the different fields in the identifier object - I think this sort of content should be reserved for the reference page. The style guide does say we should avoid repeating information, we could also add more specific guidance on where types of information should go.

@kathryn-ods
Copy link
Contributor Author

@kd-ods I've closed #531 as this page needs more discussion before merging. Here's the google doc showing my edits with some thoughts - have a look when you get a chance. https://docs.google.com/document/d/1IDMZKXrrPMSwRk5eNTxYyeJeUaCUbahcnTEkbKQkugo/edit?usp=sharing

@kathryn-ods kathryn-ods moved this from 🏗 In progress to 🔖 Ready in Release tracker: BODS version 0.4 Mar 26, 2024
@kathryn-ods
Copy link
Contributor Author

@kd-ods now that the schema descriptions have been reviewed now might be a good time to come back to this. I'm a bit concerned parts of this page are repeating/contradicting what the guidance says.

@kathryn-ods kathryn-ods moved this from 🔖 Ready to 🏗 In progress in Release tracker: BODS version 0.4 Apr 12, 2024
@kd-ods
Copy link
Collaborator

kd-ods commented Apr 17, 2024

@kathryn-ods - Once I started making suggested edits and saw your comments, I realised this page needs a wholesale re-write, putting in some thought to what we usefully want to say beyond what's in the schema.

OK if I take a crack at that Thurs?

@kathryn-ods
Copy link
Contributor Author

@kd-ods ok with me!

@kd-ods kd-ods assigned kd-ods and unassigned kathryn-ods Apr 17, 2024
@kd-ods
Copy link
Collaborator

kd-ods commented Apr 29, 2024

@kathryn-ods - this docs page is ready for you to take a look at now: https://docs.google.com/document/d/1IDMZKXrrPMSwRk5eNTxYyeJeUaCUbahcnTEkbKQkugo/edit?pli=1

(It's not a revolutionary re-write because I still think it's useful to have a page which summarises all the places in the schema where interoperability is supported by allowing inclusion of 3rd party identifiers.)

@StephenAbbott
Copy link
Member

@kd-ods @kathryn-ods Is there a good place in updated version to link to the reliable identifiers guidance? https://www.openownership.org/en/publications/using-reliable-identifiers-for-corporate-vehicles-in-beneficial-ownership-data/

@kd-ods kd-ods moved this from 🏗 In progress to 👀 In review in Release tracker: BODS version 0.4 Apr 30, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Release tracker: BODS version 0.4 May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants