docs: add warning about using absolute URLs. #63
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
switowski
changed the title
switowski
force-pushed
the
2017-10-12-do-not-use-jsonschema-urls-doc-improvement
branch
2 times, most recently
from
e71b1a0
to
e46a95a
Compare
switowski
changed the title
ntarocco
approved these changes
Oct 12, 2017
There was a problem hiding this comment.
It looks good! I would maybe add specifically that it is not also recommended to "expose" the URLs, or is it clear enough?
Like:
, it is not recommended to store and expose the JSON schema URLs...
or other kind of identifiers with the certitude that they will never change, to avoid broken references.
Sorry for my poor english...
switowski
force-pushed
the
2017-10-12-do-not-use-jsonschema-urls-doc-improvement
branch
from
e46a95a
to
749ebaf
Compare
|
Sounds good, I have updated the text! |
drjova
reviewed
Oct 13, 2017
docs/usage.rst
Outdated
| @@ -1,6 +1,6 @@ | |||
| .. | |||
| This file is part of Invenio. | |||
| Copyright (C) 2015 CERN. | |||
| Copyright (C) 2015, 2016, 2017 CERN. | |||
There was a problem hiding this comment.
why? I think we haven't touch it :)
drjova
reviewed
Oct 13, 2017
| @@ -22,7 +22,17 @@ | |||
| # waive the privileges and immunities granted to it by virtue of its status | |||
| # as an Intergovernmental Organization or submit itself to any jurisdiction. | |||
|
|
|||
| """Invenio module for building and serving JSONSchemas.""" | |||
| """Invenio module for building and serving JSONSchemas. | |||
There was a problem hiding this comment.
Good point, I moved the text but forgot about the license :P
* Adds a note to the documentation, that absolute URLs in $ref should be avoided (closes inveniosoftware#23). Signed-off-by: Sebastian Witowski <witowski.sebastian@gmail.com>
switowski
force-pushed
the
2017-10-12-do-not-use-jsonschema-urls-doc-improvement
branch
from
749ebaf
to
cd71cf9
Compare
|
It's ready to be merged |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
avoided (closes docs: add a Warning recommending not to store or advertise invenio-jsonschema URLs #23).
Signed-off-by: Sebastian Witowski witowski.sebastian@gmail.com