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

[schema/documentation] Clarify the purpose of links #187

Closed
odscjen opened this issue Aug 10, 2023 · 6 comments · Fixed by #239
Closed

[schema/documentation] Clarify the purpose of links #187

odscjen opened this issue Aug 10, 2023 · 6 comments · Fixed by #239

Comments

@odscjen
Copy link
Contributor

odscjen commented Aug 10, 2023

From suggestion in GFDRR/rdls-spreadsheet-template#3 (comment) create a codelist for link.rel from https://www.iana.org/assignments/link-relations/link-relations.xhtml. Currently this is just recommended in the field description

@duncandewhurst
Copy link
Contributor

links only exists as a standards-compliant means of declaring the version of the RDLS schema that describes the data (using the 'describedby' code) so I don't think we need to include the IANA codelist in the standard. However, we should update the schema descriptions and documentation to clarify the purpose of links. Sound good?

@odscjen
Copy link
Contributor Author

odscjen commented Aug 11, 2023

That makes a lot of sense to me, @matamadio is that sufficient?

@matamadio
Copy link
Contributor

If the only IANA codelist expected is "describedby", then I don't see the reason to allow the choice to user. The field should have that value in the template already.

@duncandewhurst
Copy link
Contributor

Sounds good. I've created an issue on the template repo and will rename this issue to be about clarifying the purpose of links in the schema and documentation.

@duncandewhurst duncandewhurst changed the title [schema] create IANA_link_relationship_type codelist [schema/documentation] Clarify the purpose of links Aug 14, 2023
@matamadio
Copy link
Contributor

matamadio commented Aug 22, 2023

Agreed and implemented (auto-populating with describedby); this can be closed.

@odscjen
Copy link
Contributor Author

odscjen commented Aug 22, 2023

I'm going to leave this open to remind us to include the clarification in the guidance as well as the autopopulation now in the spreadsheet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
3 participants