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

Add JSON schemas to AsciiDoctor output. #1907

Merged
merged 2 commits into from
Nov 24, 2020
Merged

Add JSON schemas to AsciiDoctor output. #1907

merged 2 commits into from
Nov 24, 2020

Conversation

emackey
Copy link
Member

@emackey emackey commented Nov 24, 2020

@oddhack This is a PR into your branch, to add the JSON schema file contents.

via CesiumGS/wetzel#51

@emackey emackey requested a review from oddhack November 24, 2020 02:07
@emackey
Copy link
Member Author

emackey commented Nov 24, 2020

for #1901

specification/2.0/Makefile Show resolved Hide resolved

WETZEL = npx wetzel
SCHEMALINK = https://github.com/KhronosGroup/glTF/tree/master/specification/2.0/schema
SCHEMALINK = schema
EMBEDSCHEMA = JsonSchemaReference.adoc

# Base name of the generated properties reference file
PROPREF = PropertiesReference
# Schema files to leave out of $(PROPREF)
IGNORESCHEMA = '["gltfchildofrootproperty.schema.json", "gltfid.schema.json", "gltfproperty.schema.json"]'
$(PROPREF).adoc: $(wildcard schema/*.json)
Copy link
Contributor

Choose a reason for hiding this comment

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

Would add $(EMBEDSCHEMA) to targets here. Might want some sort of npx dependency too, but I'm not sure how that would work since the wetzel files are pulled from a remote.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think in the next round of changes I'm going to add the version number onto the end of wetzel. Specifically, something like this:

WETZEL = npx wetzel@0.1.0-dev.1.2

That way, updates to new versions of wetzel must be manually done in the Makefile, not just pulled in automatically whenever someone publishes. This would provide more stability of the history, for example pulling an old commit and re-running the old documentation would use the specific version of wetzel available at that point in history, and should exactly regenerate what the docs were back then. Likewise, changes to the docs introduced by new wetzel versions could be found with bisect, etc.

specification/2.0/Makefile Show resolved Hide resolved
@oddhack
Copy link
Contributor

oddhack commented Nov 24, 2020

I'll accept once you've made those changes, unless you want to hold off.

@oddhack
Copy link
Contributor

oddhack commented Nov 24, 2020

Going to go ahead and merge this now and make the changes I recommended above - something I wanted to tweak in the appendix section layout and it will be easier to check in my branch.

@oddhack oddhack merged commit 90751fb into jon-adoc Nov 24, 2020
@emackey emackey deleted the ed-adoc-embed branch November 24, 2020 13:59
emackey added a commit that referenced this pull request Nov 24, 2020
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.

2 participants