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

Add appendix "Informative references" to published spec documents #3740

Open
ralfhandl opened this issue Apr 24, 2024 · 4 comments
Open

Add appendix "Informative references" to published spec documents #3740

ralfhandl opened this issue Apr 24, 2024 · 4 comments
Assignees

Comments

@ralfhandl
Copy link
Contributor

ralfhandl commented Apr 24, 2024

Check existing non-RFC links whether they are normative or informative, for example links to the YAML specification, or links to the JSON Schema specifications.

Add appendix "Informative references" for selected external links that we deem non-normative and worth mentioning.

@handrews
Copy link
Contributor

For those wondering why this is in "Automation & Infrastructure", the "Normative References" appendix seems to be added by the HTML generation script- it is not present in our (allegedly normative) Markdown document. Which strikes me as odd- are not normative references a normative part of the spec?

@ralfhandl
Copy link
Contributor Author

Just noted this inconsistency:

image

The Markdown spec source already has an "Appendix A" with the version history, which is rendered in HTML as chapter 5, and the normative references are added as second Appendix A.

@Bellangelo
Copy link
Contributor

Bellangelo commented May 6, 2024

The References section is being done by the Respec and it happens client-side. I have validated by checking the md2html script, which doesn't handle the references, and by checking the source code of the website. If you check it, you will see that this section is missing.

You can check the documentation of Respec here: https://respec.org/docs/#:~:text=ReSpec%20uses%20the%20context%20of,reference%20is%20treated%20as%20normative.

In the md2html that tries to fix some links. Maybe we could use the same functionality.

@handrews
Copy link
Contributor

ReSpec has syntax for informative references. We don't consistently use its syntax for references, and we possibly should. That might be more predictable than relying on inferences and heuristics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

3 participants