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 "Try It" #82

Closed
sonicaghi opened this issue May 14, 2015 · 17 comments
Closed

add "Try It" #82

sonicaghi opened this issue May 14, 2015 · 17 comments
Assignees

Comments

@sonicaghi
Copy link
Member

Terminal simulator with an interactive tutorial to learn the basics of Kong.

Example: https://www.docker.com/tryit/

@sonicaghi
Copy link
Member Author

@nijikokun what's the name of that tool that does virtual terminals in the browser?

@nijikokun
Copy link
Contributor

There are quite a few:

@ahmadnassri
Copy link
Contributor

will be very tricky for us, since we have an API for admin control, meaning parsing and mimicking cURL commands ... (vs. docker is pre-set cli commands)

better to use http://runnable.com/ and embed on site for an interactive setup with a REAL Kong instance ...

@ahmadnassri
Copy link
Contributor

here you go: http://runnable.com/VVVzgrrneBwFOSnA/

we can use this as a starting point for an interactive shell tutorial ...

@rainum
Copy link
Contributor

rainum commented May 15, 2015

Thanks @ahmadnassri! Can you tell me how can I embed runnable terminal window? Only with iframe or there is proper way to do this?

@sinzone where should we place this tutorial? Maybe I should create separate docs section for it like http://take.ms/MKqae?

@ahmadnassri
Copy link
Contributor

with runnable.com there doesn't seem to be an embed function, and it seems to be the same session / server for everyone ... perhaps pointing people there is one way to do it, they can fork and create their own instance.

@sonicaghi
Copy link
Member Author

"Try It" goes in the header bar and it's a new page. not in the doc.

runnable is nice but too bad doesn't have embedded feature and unique sessions. so, we need to go back to terminal emulators and just show a subset of feature, excluding API admin.

@ahmadnassri
Copy link
Contributor

but there are no features without the admin API ... all you can do is "start" and "stop"

@thibaultcha
Copy link
Member

Well there is a PR to manipulate the data from the CLI too. It was not included in 0.3 but could have, we talked about it...

@ahmadnassri
Copy link
Contributor

if we get full control from the CLI, then we can build a faux terminal and use that for demos .... still a lot of work to mock everything (and keep updating it with new plugins / features) vs. a real instance ...

@rainum
Copy link
Contributor

rainum commented May 18, 2015

Ok, I think we should wait until Kong with CLI data manipulation will be released. We will see than what we can do.

@shashiranjan84
Copy link
Contributor

we can try to put TRY IT which is a link to Runnable.

@ahmadnassri
Copy link
Contributor

closed with 9e18deb

@montanaflynn
Copy link

When I go to to runnable I try to use the terminal in the bottom (not clicking Run) and it doesn't work because that container and port is no longer running.

There's also another bug in the demo, you need to add a sleep 5 in main.sh between the request and starting Kong since the container won't be running by the time the script starts kong.

The biggest problem with sending people directly to runnable is it has no associated tutorial so it loses any benefit of teaching or showcasing functionality.

I have a full Kong demo available powered by docker + term.js that's online here for now: http://trykong.cloudbrain.io, we can get a new domain or point a subdomain to it like demo.getkong.org.

Once 0.3.0 drops I'll update the image and we can switch it out for runnable. I wrote a small guide that I think is quicker and IMO a better showcase of Kong than the current 5 minute quickstart guide which we could use specifically for this purpose. My demo image also includes jq and siege so people can really play around with Kong, I also have it exposed to the public (try echo $HOST in the demo) but kong doesn't support wildcard subdomains yet (Kong/kong#297) and honestly it might be better to not allow outside access for these purposes.

I'd like to create a special page with the tutorial so it looks more like this (removing sidebar, making terminal responsive by moving from side to bottom on smaller screens)

screen shot 2015-06-03 at 7 45 06 pm

screen shot 2015-06-03 at 7 47 30 pm

@ahmadnassri
Copy link
Contributor

@montanaflynn the runnable example was never meant to be used for this, @sinzone put it on afterwards as a temp.

@montanaflynn
Copy link

Alright then let's reopen this issue.

My demo with the guide and kong terminal loads super slow compared to trykong.cloudbrain.io:8080 which doesn't support copy + paste. The javascript is built with browserify and is huge (2+ mb) so it might be best to preload it on getkong.org. I'm waiting for 0.3.0 to come out so I can add a cache header using response transformation plugin which will make preloading a viable option.

@montanaflynn montanaflynn reopened this Jun 4, 2015
@ahmadnassri ahmadnassri assigned ahmadnassri and unassigned rainum Aug 16, 2015
@ahmadnassri
Copy link
Contributor

closing this in favor of upcoming Kong Cloud service

thibaultcha pushed a commit that referenced this issue Sep 17, 2018
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

No branches or pull requests

7 participants