v3 -> v4 changes - #143
v3 -> v4 changes#143meldra wants to merge 1 commit into
Conversation
This change adds a `badge` shortcode built based on the supported versions config added recently. It will help reduce the number of places the version number needs updating. Sadly, adding shortcodes to codeblocks ruins their formatting. The badge has been added to the json-ld page to replace the existing badge there, and has also been added to the tools page to further emphasize the latest version as described in codemeta#122. It was also added to the context section of the user guide. The user guide retains links to real-world examples using old versions towards the end of the document. An admonition has been added under the examples links to prompt people to check and not copy it verbatim without due care.
|
At some point, we need to decide what version string format we want to stick with in the content (with perhaps the context URLS being excepted of course) and be consistent. The updates this round have kept the formats consistent with the contexts they were in, for example on the tools page, which uses a As far as I can tell, there is not an in-use version that uses the last segment of that format. |
To be clear, this doesn't really make sense to me. This is a discussion for the community though. |
|
Draft until v4 officially released |
|
Thanks @meldra. We'll have/can discuss this at the weekly Tuesday meetings: (i) Version format: agreed. Proposal: major.minor in content ( (ii) Clash with #144: with (iii) Tools page, #122: #131's Esteban will pick up on the PR Kind regards, |
@lindangulopez your rationale for the change was:
Should we change focus from that statement and put less emphasis on alerting of risks/safety and instead use affirmation of the latest version? A warning that applies to everything will indeed saturate its meaning and make it useless. |
preview demo: https://codemeta.opinions.monster/tools/ |
This branch has not been deployed
2 participants
This change adds a
badgeshortcode built based on the supported versions config added recently. It will help reduce the number of places the version number needs updating. Sadly, adding shortcodes to codeblocks ruins their formatting.The badge has been added to the json-ld page to replace the existing badge there, and has also been added to the tools page to further emphasize the latest version as described in #122. It was also added to the context section of the user guide.
The user guide retains links to real-world examples using old versions towards the end of the document. An admonition has been added under the examples links to prompt people to check and not copy it verbatim without due care.