Repository navigation
How are the examples and code snippets mastered and processed? #826
Description
I am looking into understanding how gcloud-node handles documentation and code examples, to learn more about where the doc example snippets are mastered and how they are automatically validated etc.
JJ mentioned that the best way to reach the team was to open a github issue. Would one of the owners be able to reach me so that we can a quick 30 min sync?
(JJ: removing confidential content)
Activity
jgeewax commentedon Aug 26, 2015
How about we just answer here.... Do you have specific questions that you want answered?
(I also removed confidential stuff -- sorry for editing your comment out from under you)
[-]Need information around how the examples and code snippets are mastered and processed[/-][+]How are the examples and code snippets mastered and processed?[/+]jgeewax commentedon Aug 26, 2015
Also -- what do you mean by "mastered"?
callmehiphop commentedon Aug 26, 2015
Our example code is tested when we run
npm run test, this does the following:dox(via shell script)There is a documentation spec file that then parses all the JSON generated via
doxand proceeds to run all of the@examplesections within a sandboxed environment created using Node's vm module and mitm.jgeewax commentedon Aug 27, 2015
@vsubramani : Does this answer your question ?
stephenplusplus commentedon Aug 31, 2015
Feel free to continue discussing if you have more questions @vsubramani. Thanks for asking!
vsubramani commentedon Aug 31, 2015
This answers my question. Thanks folks.
chore: release 4.1.0 (#826)
build(test): recursively find test files; fail on unsupported depende…
chore: release 6.4.1 (#826)
chore: release 6.4.1 (#826)
chore: release 6.4.1 (#826)
build: fix path in generator test (#826)