WIP: V1 Sample Skeleton #11
Conversation
sdesmond46
left a comment
sdesmond46
left a comment
There was a problem hiding this comment.
I think it looks good overall. I like the idea of having the tutorial and the samples as separate folders. Would we then just have one more folder for docs?
Samples/README.md
Outdated
| Follow these instructions to run any of the samples in the Samples directory. The only exception is the React Tutorial, that sample has its own README and setup instructions. | ||
|
|
||
| ### Pre-requisites | ||
| * You must have Node.js or Python installed (or other software which can serve the contents of this folder over http). You can get Node.js from http://nodejs.org and Python from https://www.python.org/downloads/ |
There was a problem hiding this comment.
Do these links need to be marked as links?
Samples/README.md
Outdated
| * You must have Node.js or Python installed (or other software which can serve the contents of this folder over http). You can get Node.js from http://nodejs.org and Python from https://www.python.org/downloads/ | ||
|
|
||
| ### Setup | ||
| 1. Copy the `.trex` files of the sample you wish to run to `~\Documents\My Tableau Repository (Beta)\Extensions` so they are available to Tableau. |
There was a problem hiding this comment.
Do you think maybe we should just have node / npm be a requirement of our sdk? Then we could just tell people to run things like node start for the test server or node run setup to copy the .trex files to the right place?
I think it might make things simpler in terms of docs and shouldn't be too painful for anyone
There was a problem hiding this comment.
I would definitely prefer that. This was just copy paste from existing. The setup idea is really good.
There was a problem hiding this comment.
Let me play around with that and getting existing samples fleshed out.
|
For GitHub pages, we also have a few other directories at the root level in addition to /docs: |
Opening this for discussion before continuing to build the samples. A few things to discuss:
After we get this skeleton in, we can parallelize the sample work. I'll do the four samples in the samples folder, @sdesmond46 you got the tutorial?