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

Document the schema #49

Open
waldoj opened this issue Oct 16, 2014 · 5 comments
Open

Document the schema #49

waldoj opened this issue Oct 16, 2014 · 5 comments

Comments

@waldoj
Copy link
Member

waldoj commented Oct 16, 2014

Create a GitHub Pages-hosted project to document the schema. Properly created JSON schemas should make it possible to build the core of the documentation automatically.

@waldoj
Copy link
Member Author

waldoj commented Oct 16, 2014

Created a gh-pages branch and a placeholder site.

waldoj added a commit that referenced this issue Oct 16, 2014
The content at the URL is just a placeholder, but now we know where
we’ll find it (for now). Per #49.
@waldoj
Copy link
Member Author

waldoj commented Oct 30, 2014

"matic" looks like the best way to do this, with the catch that we can't trigger it with pure-GitHub Jekyll. It'll have to be updated locally, with the changes pushed to the repository.

@waldoj
Copy link
Member Author

waldoj commented Oct 31, 2014

This will need a domain, too. huntingdata.org is available.

@waldoj
Copy link
Member Author

waldoj commented Dec 23, 2014

I settled on rooseveltschema.org, figuring I'll brand it the Roosevelt schema.

@waldoj
Copy link
Member Author

waldoj commented Jun 1, 2015

I tried running matic. It just creates a directory with the schemas in it. I can't get it to generate documentation—most config options just produce this:

$ matic
/usr/local/lib/node_modules/matic/lib/build.js:18
    this.clipboard.files[fileName] = template(index.call(this, config));
                                     ^
TypeError: undefined is not a function
    at module.exports (/usr/local/lib/node_modules/matic/lib/build.js:18:38)
    at module.exports (/usr/local/lib/node_modules/matic/node_modules/rightclick/lib/tap.js:4:24)
    at /usr/local/lib/node_modules/matic/lib/matic.js:19:8
    at FSReqWrap.oncomplete (fs.js:99:15)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant