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

schema: add a README #360

Merged
merged 1 commit into from
Apr 13, 2016
Merged

schema: add a README #360

merged 1 commit into from
Apr 13, 2016

Conversation

vbatts
Copy link
Member

@vbatts vbatts commented Mar 30, 2016

Signed-off-by: Vincent Batts vbatts@hashbangbash.com


The layout of the files is as follows:
* schema.json - the primary entrypoint for the whole schema document
* schema-linux.json - this schema is for the Linux specific sub structure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“Linux-specific sub-structures”?

* defs.json - definitions for general types
* defs-linux.json - definitions for Linux-specific types
* validate.go - validation utility source code

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git show --check origin/pr/360 highlights some trailing whitespace on this line. I had a commit for checking that automatically in #182 (bdaf446), if you want to port it to vbatts/git-validation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

@vbatts vbatts force-pushed the schema-README branch 2 times, most recently from 5bba104 to f040e1f Compare April 12, 2016 03:36
@wking
Copy link
Contributor

wking commented Apr 12, 2016 via email

@mrunalp
Copy link
Contributor

mrunalp commented Apr 13, 2016

LGTM

validating the `config.json` of this container runtime specification.

The layout of the files is as follows:
* schema.json - the primary entrypoint for the whole schema document
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: add links to these files

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yeah.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@vishh
Copy link
Contributor

vishh commented Apr 13, 2016

Super helpful. Thanks for this PR @vbatts !! LGTM

validating the `config.json` of this container runtime specification.

The layout of the files is as follows:
* [schema.json](./schema.json) - the primary entrypoint for the whole schema document
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pedantic nit: the other link targets don't have a leading ./, so maybe remove this one for consistency?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

muscle memory. fixed.

On Wed, Apr 13, 2016 at 1:43 PM, W. Trevor King notifications@github.com
wrote:

In schema/README.md
#360 (comment)
:

@@ -0,0 +1,32 @@
+# JSON schema
+
+## Overview
+
+This directory contains the JSON Schema for
+validating the config.json of this container runtime specification.
+
+The layout of the files is as follows:
+* schema.json - the primary entrypoint for the whole schema document

Pedantic nit: the other link targets don't have a leading ./, so maybe
remove this one for consistency?


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
https://github.com/opencontainers/runtime-spec/pull/360/files/57d2484193eb1631c186f308cf65c1f0fac43952#r59592283

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
@mrunalp mrunalp merged commit 53f0da5 into opencontainers:master Apr 13, 2016
@vbatts vbatts deleted the schema-README branch May 2, 2016 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants