Fix: Interlink terms in UJS with the glossary #520
Conversation
| @@ -8,7 +8,7 @@ Understanding JSON Schema | |||
|
|
|||
| <img src="understanding/octopus.svg" className="w-1/2 float-right" /> | |||
|
|
|||
| JSON Schema is a powerful tool for validating the structure of JSON | |||
| [JSON](../learn/glossary#json) [Schema](../learn/glossary#schema) is a powerful tool for validating the structure of JSON | |||
There was a problem hiding this comment.
JSON Schema is one single thing, please dont make this separation of terms.
There was a problem hiding this comment.
Okay I understand that they are one single thing but I did not find one single glossary term for JSON schema. JSON and schema are separate glossary term in glossary page. How do I point them to single glossary term ? Could you please give me idea about that?
| @@ -17,7 +17,7 @@ instructor for JSON Schema. It\'s for those that want to write it and | |||
| understand it, but maybe aren\'t interested in building their own | |||
| car—er, writing their own JSON Schema validator — just yet. | |||
|
|
|||
| > This tutorial describes JSON Schema draft 2020-12. Earlier versions of | |||
| > This tutorial describes JSON Schema [draft](../learn/glossary#draft) 2020-12. Earlier versions of | |||
There was a problem hiding this comment.
Just add a link to draft when draft is being used alone without pointing to one specific draft version. the version of this draft is "draft 2020-12" everything together. We'll link to draft when the word is used alone.
There was a problem hiding this comment.
Okay I will correct it.
| @@ -6,7 +6,7 @@ section: "docs" | |||
| If you\'ve ever used XML Schema, RelaxNG or ASN.1 you probably already | |||
| know what a schema is and you can happily skip along to the next | |||
| section. If all that sounds like gobbledygook to you, you\'ve come to | |||
| the right place. To define what JSON Schema is, we should probably first | |||
| the right place. To define what [JSON](../learn/glossary#json) [Schema](../learn/glossary#schema) is, we should probably first | |||
There was a problem hiding this comment.
JSON Schema is one single thing, please dont make this separation of terms.
There was a problem hiding this comment.
JSON and schema are separate glossary term in glossary page. How do I interlink them to single glossary term ?
| and hopefully justified the need for schema languages. Here, we proceed | ||
| to write a simple JSON Schema. | ||
| to write a simple [JSON](../learn/glossary#json) Schema. |
There was a problem hiding this comment.
JSON Schema is one single thing, please dont make this separation of terms.
| @@ -5,11 +5,11 @@ title: "Conventions used in this documentation" | |||
|
|
|||
| ## Language-specific notes | |||
|
|
|||
| The names of the basic types in JavaScript and JSON can be confusing | |||
| The names of the basic types in JavaScript and [JSON](../learn/glossary#json) can be confusing | |||
There was a problem hiding this comment.
I'll avoid interlinking JSON because everybody knows it and it is everywhere.
There was a problem hiding this comment.
Okay I will undo it.
| when coming from another dynamic language. I\'m a Python programmer by | ||
| day, so I\'ve notated here when the names for things are different from | ||
| what they are in Python, and any other Python-specific advice for using | ||
| JSON and JSON Schema. I\'m by no means trying to create a Python bias to | ||
| JSON and JSON [Schema](../learn/glossary#schema). I\'m by no means trying to create a Python bias to |
There was a problem hiding this comment.
JSON Schema is one single thing, please dont make this separation of terms.
|
Hey @benjagm, |
What kind of change does this PR introduce?
Documentation Enhancement
Issue Number:
Screenshots/videos:
If relevant, did you update the documentation?
Yes
Summary
Does this PR introduce a breaking change?
No