coralproject / ask-docs

Official Ask Documentation for The Coral Project
https://docs.coralproject.net/ask/
Other
11 stars 14 forks source link

Elkhorn documentation #38

Closed aiboyles closed 7 years ago

aiboyles commented 8 years ago

Flesh out current Elkhorn documentation:

aiboyles commented 8 years ago

I need to flesh out the "Contributing a new widget" portion, and am also waiting on additional info for the API.

aiboyles commented 8 years ago

Pending review from @pablocubico.

pablocubico commented 7 years ago

Great work! These docs look great. Just a couple of minor notes:

Ask Composer

Partial states may be stored locally, even if S3 has been set up -- Not sure what this line means...

Set up configuration file

If you installed Pillar locally as a Docker container, pillarHost should be http://10.0.4.105:8080. http://10.0.4.105 is the URL generated by Docker. -- I'm not familiar with these IPs, check with Eugene in any case

Contributing an answer field

Extend the AskInterface interface: Your question field class will extend the AskField interface. -- Typo! It should say "Extend the AskField interface"

aiboyles commented 7 years ago

ping @pablocubico can you make sure you review the API portion? You can ping me on Slack with any questions.

pablocubico commented 7 years ago

Looks good to me, except for the missing example messages!

pablocubico commented 7 years ago

@jtnelson here you go: https://gist.github.com/pablocubico/f3eaae62600d497e33eaaa865425ab15 (probably you'll want to hide urls or things that shouldn't go there)

I think we can delete the examples for iframe and preview, as those will not return JSON but an entire JS/HTML file for the iframe or the preview.