-
-
Notifications
You must be signed in to change notification settings - Fork 229
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
Fix: Interlink terms in UJS with the glossary #520
Changes from 1 commit
80401d7
51c8e64
26ce431
a485749
1b052f5
bbc8cd6
a657c87
ebeec91
6e038f3
5e713bd
d15da90
dc3ed69
b902217
dec7203
66ba291
6a9803d
04d9c19
ffe057f
af83554
e01a84c
4c03832
948242e
83cb889
7b35d94
cc12cc1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
data. However, learning to use it by reading its specification is like | ||
learning to drive a car by looking at its blueprints. You don\'t need to | ||
know how an electric motor fits together if all you want to do is pick | ||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Okay I will correct it. |
||
JSON Schema are not completely compatible with the format | ||
described here, but for the most part, those differences are noted | ||
in the text. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON Schema is one single thing, please dont make this separation of terms. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON and schema are separate glossary term in glossary page. How do I interlink them to single glossary term ? |
||
define what JSON is. | ||
|
||
JSON stands for \"JavaScript Object Notation\", a simple data | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,9 +3,9 @@ title: The basics | |
section: docs | ||
--- | ||
|
||
In [What is a schema?](../understanding-json-schema/about), we described what a schema is, | ||
In [What is a schema?](../understanding-json-schema/about), we described what a [schema](../learn/glossary#schema) is, | ||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON Schema is one single thing, please dont make this separation of terms. |
||
|
||
## Hello, World! | ||
|
||
|
@@ -78,7 +78,7 @@ false | |
|
||
Of course, we wouldn\'t be using JSON Schema if we wanted to just accept | ||
any JSON document. The most common thing to do in a JSON Schema is to | ||
restrict to a specific type. The `type` keyword is used for that. | ||
restrict to a specific type. The `type` [keyword](../learn/glossary#keyword) is used for that. | ||
|
||
> When this book refers to JSON Schema "keywords", it means the | ||
"key" part of the key/value pair in an object. Most of the work | ||
|
@@ -105,7 +105,7 @@ The `type` keyword is described in more detail in [here](../understanding-json-s | |
|
||
## Declaring a JSON Schema | ||
|
||
It\'s not always easy to tell which draft a JSON Schema is using. You | ||
It\'s not always easy to tell which [draft](../learn/glossary#draft) a JSON Schema is using. You | ||
can use the `$schema` keyword to declare which version of the JSON | ||
Schema specification the schema is written to. See [$schema](../understanding-json-schema/reference/schema#schema) | ||
for more information. It\'s generally good practice to include it, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll avoid interlinking JSON because everybody knows it and it is everywhere. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON Schema is one single thing, please dont make this separation of terms. |
||
this book, but it is what I know, so I\'ve started there. In the long | ||
run, I hope this book will be useful to programmers of all stripes, so | ||
if you\'re interested in translating the Python references into Algol-68 | ||
|
@@ -40,7 +40,7 @@ In Swift, JSON can be read using the `JSONDecoder` class. | |
## Draft-specific notes | ||
|
||
The JSON Schema standard has been through a number of revisions or | ||
\"drafts\". The current version is Draft 2020-12, but some older drafts | ||
[\"drafts\"](../learn/glossary#draft). The current version is Draft 2020-12, but some older drafts | ||
are still widely used as well. | ||
|
||
The text is written to encourage the use of Draft 2020-12 and gives | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JSON Schema is one single thing, please dont make this separation of terms.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?