Are we fine with having the link to it under: /docs/x.x.x/download?

By appending the -L argument to every curl command.

Let's discuss how we can improve the 404 page.

http://www.meetup.com/meetup_api/buttons/

keeping it simple: link to Google search with "site:getkong.org SEARCH_TERM"

1. For the enterprise form and the newsletter updates, when you call identify, please also add "created_at" = datetime (unix time)
2. For the enterprise form, on submit, please also call analytics.track event for “request_enterprise_demo" with the properties.
   Example:

analytics.track('request_enterprise_demo',{
    company: 'Mashape',
    deployment: 'on-prem',
    email: '[email protected]',
    name: 'christina test',
    phone: '4321',
    request_date: date/time of submission
})

1. For the newsletter updates, same thing, on submit, please call analytics.track event for “request_newsletter_updates” with the properties.

Alternatively, you can use the trackform function instead of track, whichever one is easier for you - https://segment.com/docs/libraries/analytics.js/#track-form

Basically, if the same user (same email) submits the form twice, it should call the analytics.track event twice with two different submit date/time.

• to list all required packages for installations across different distribution methods.
• to link from the download page with the text: "check all your dependencies are met, click here for a full list of requirements."

NOTE this is turning into an install debugging thread, i'll list everything here then separate out into individual tickets as applicable, for now using this as a draft space.

• sudo is a requirement for kong.postinst but it probably shouldn't be, we can use "su" which comes pre-installed with most distros anyways, can use su -c ‘command’

In the configuration section of the plugin page there's an extra trailing slash:

curl -X POST http://kong:8001/apis/{api_id}/plugins \
    --data "name=requestsizelimiting" \
    --data "allowed_payload_size=128" \

There's also an issue with allowed_payload_size missing the value prefix:

curl -i -X POST http://localhost:8001/apis/e3870142-ff01-4e0c-ce6f-6ca9665d915c/plugins \
    --data "name=requestsizelimiting" \
    --data "allowed_payload_size=128"

HTTP/1.1 400 Bad Request
{"allowed_payload_size":"allowed_payload_size is an unknown field"}

This worked:

curl -i -X POST http://localhost:8001/apis/e3870142-ff01-4e0c-ce6f-6ca9665d915c/plugins \
  --data "name=requestsizelimiting" \
  --data "value.allowed_payload_size=10"

HTTP/1.1 201 Created
Date: Sat, 06 Jun 2015 02:09:45 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: kong/0.3.0

{"api_id":"e3870142-ff01-4e0c-ce6f-6ca9665d915c","value":{"allowed_payload_size":10},"id":"b407b2b5-75ca-40a9-c0b2-d293d6f67267","enabled":true,"created_at":1433556585000,"name":"requestsizelimiting"}

should send confirmation email if being added to a mailing list.

See Kong/kong#132

For the twitter button in the footer, please make it such that it will always tweet the same message regardless of the page that the user is at.

The message should be:

KONG - the open-source management layer for APIs and Microservices http://getkong.org/ #opensource #API #management

currently the support section only talks about enterprise paid support, should also include open-source support through github issues, IRC, gitter, etc ...

Right now the footer is only shown on the homepage, please include it in all the pages, especially download/ install page.

There is no dropdown visible even when having multiple versions.

The kong.yml links on the download page are broken, possibly in other places as well.

At the bottom of the installation instructions we have the text:

Something went wrong? Check out the Docs ›

Instead of sending them to the docs which won't be of any use it would be better to send them to the support page with our glitter channel and enterprise support options.

Text replacement could be like:

Having trouble? We're here to help!

We should write a little guide to install Cassandra.

guide suggests adding a plugin: Add keyauth under the plugins_available property in your Kong instance configuration file

however, it seems all plugins are already added and enabled by default.

it occurred to me (from customer feedback) that the usage of Host header in examples are causing some confusion for people.

basically, its empowering the assumption that you need to call the proxy address directly and pass a Host header, where in a real-world implementation, you should be able to point any DNS address (domain / subdomain) to your proxy network address and no longer require passing of a Host header in your HTTP request.

this is not an obvious conclusion from following the tutorial and reading the docs, and it does count as a bit of an advanced knowledge for some developers.

suggestion: add a "deploying to production" section in the tutorial (at the end) that describes this as well as any related considerations when going to production.

In FirefoxDeveloperEdition the list item text gets pushed below the bullet point:

_layouts/docs.html is what is on the left side of a documentation page. Not every version to document will have the same articles (in fact, the 2 versions we currently have already differ, resulting in a few 404s), and in the future there might be a lot more to it.

To dynamically generate it, we can either have a list of all articles in kong_versions.yml, or we could dynamically generate that list via the versions.rb plugin. One is more flexible, the other is less to maintain.

Then docs.html simply becomes:

<aside class="page-navigation">
  {% for section in page.doc_link %}
  <nav>
    <h5>{{section.title}}</h5>
    <ul>
      {% for article in section.articles %}
        <li href="/docs/{{page.kong_version}}/{{article.link}}">{{article.name}}</li>
      {% endfor %}      
    </ul>
  </nav>
  {% endfor %}
</aside>

Which solution do we like better: YAML or automated?

Taken out from #86

Display a warning on top of every doc page when the user is not seeing the most recent version of the documentation. Include a link to the most recent version.

@jitachi Do you have guidelines or a mockup to implement this? Thanks

• Why Cassandra
• How to install Cassandra
• How to scale Cassandra

At the page /docs/0.2.0-2/configuration/ the nginx configuration is not rendering the {{*}} placeholders (like {{auto_worker_rlimit_nofile}}) although they have been defined in the source.

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

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

Screenshot taken from: http://getkong.org/docs/0.2.0-2/about/what/

• How many nodes for any amount of traffic
• How many Cassandra nodes for a Kong cluster
• How to distribute and/or scale Kong
• How to load balance your traffic on a Kong cluster
• How to setup a production ready Cassandra cluster (authentication/authorization/multi-region)
• How to setup your DNS records to leverage the Host header #87
• How to upgrade Kong without downtime
• How and why to protect the Admin API (8001)
• How to link your users to Kong (custom_id)

I think it needs some more writing to be more obvious

Kong will be released with the following supported distributions:

• Amazon Linux AMI (.rpm) @thefosk
• CentOS 5/6/7 (rpm) @thefosk
• Debian 6/7 (.deb) @thefosk
• Ubuntu 12.04/14.04 (.deb) @thefosk
• OS X
  • pkg @thefosk
  • homebrew @thibaultcha
  • script @nijikokun
• Other

The current location is easy to skip over and miss at first glance.

Right now we have dependencies listed as step one for "Other" which is where I would expect Casandra to be mentioned as well. We also mention that Cassandra must be running in the "Start Kong" section for all distributions except for Docker but I feel it should be clear it's a dependency before you get there.

this will break any tracking events.

<a href="/download" class="button" data-analytics="{&quot;event&quot;: &quot;Clicked download&quot;, &quot;type&quot;: &quot;button&quot;, &quot;location&quot;: &quot;header&quot;}">Download</a>

Please add the following to kong website:

1. Json-LD

<script type="application/ld+json">
{ "@context" : "http://schema.org",
  "@type" : "Organization",
  "name" : "Mashape",
  "url" : "http://getkong.org/",
  "logo" : "[replace with image url]",
  "sameAs" : [ "https://www.facebook.com/Mashape",
    "https://twitter.com/mashape",
    "https://plus.google.com/+mashape"]
}
</script>

• (replace image url with the mashape logo url)
  

2. VWO script

<!-- Start Visual Website Optimizer Asynchronous Code -->
<script type='text/javascript'>
var _vwo_code=(function(){
var account_id=125292,
settings_tolerance=2000,
library_tolerance=2500,
use_existing_jquery=false,
// DO NOT EDIT BELOW THIS LINE
f=false,d=document;return{use_existing_jquery:function(){return use_existing_jquery;},library_tolerance:function(){return library_tolerance;},finish:function(){if(!f){f=true;var a=d.getElementById('_vis_opt_path_hides');if(a)a.parentNode.removeChild(a);}},finished:function(){return f;},load:function(a){var b=d.createElement('script');b.src=a;b.type='text/javascript';b.innerText;b.onerror=function(){_vwo_code.finish();};d.getElementsByTagName('head')[0].appendChild(b);},init:function(){settings_timer=setTimeout('_vwo_code.finish()',settings_tolerance);this.load('//dev.visualwebsiteoptimizer.com/j.php?a='+account_id+'&u='+encodeURIComponent(d.URL)+'&r='+Math.random());var a=d.createElement('style'),b='body{opacity:0 !important;filter:alpha(opacity=0) !important;background:none !important;}',h=d.getElementsByTagName('head')[0];a.setAttribute('id','_vis_opt_path_hides');a.setAttribute('type','text/css');if(a.styleSheet)a.styleSheet.cssText=b;else a.appendChild(d.createTextNode(b));h.appendChild(a);return settings_timer;}};}());_vwo_settings_timer=_vwo_code.init();
</script>
<!-- End Visual Website Optimizer Asynchronous Code -->

3. Existing meta property og:description

Please change to:

Kong is the Next Generation RESTful API Management Platform to secure, manage & extend your APIs or Microservices. Made with Love by Mashape.

4. Share image

Please replace http://getkong.org/share.png image with the attached kong image and make sure it is available on http://getkong.org/share.png

5. Send users who sign up for email updates to customer.io

Format for identifying users via segmentio's identity function is wrong. Instead of nesting userId inside the traits object, you need to send it as the first param.
You need to send this:

analytics.identify('[email protected]', {
  email: "[email protected]",
  environment: 'kong',
  name: 'Christina Ng'
});

Right now, you are sending this which doesnt work:

analytics.identify({
  userId: '[email protected]',
  environment: 'kong',
  name: 'Christina Ng',
  email: "[email protected]"
});

6. Send event for Viewed XX page

We need to send custom events for "Viewed XX page" e.g. "Viewed Documentation page" and "Viewed Enterprise page" and "Viewed Plugins page" etc via analytics.track.

This is because mixpanel doesnt allow me to build a funnel using the analytics.page events so I need a separate analytics.track event.

two questions:

• should we standardize spacing? (e.g. some JSON snippets have 4 spaces, curl have 2)
• do we really need a dollar sign for bash snippets? makes it more annoying to copy-paste.

Should it be

kong start -c /path/to/conf.yml

or what I think

kong start -c /path/to/kong.yml

based on the first line referring to kong.yml not conf.yml

http://getkong.org/docs/0.1.1beta-2/getting-started/configuration/

P.s. it's the little things ;)

Some users have been emailing with confusion surrounding the workings of the Proxy Layer API which resides on port 8000

Perhaps a page where it is explained in detail, what headers are required (even if only one), what features it supports, and the likes would cure the situation we currently face.

As it stands of now there are only glimpses into how it works:

http://getkong.org/docs/0.2.1/getting-started/adding-your-api/

These links here:
https://github.com/Mashape/kong#documentation

kinda 404

A to-be-improved list of things to document for the upcoming 0.3.0, with links to possible documentation when available:

• Admin API
  • New routes to document in the sidebar, /plugins_configurations should be considered deprecated in favour of /apis/{api}/plugins Kong/kong#257
  • Update the tutorials to use the new routing (/apis/{api}/plugins and /consumer/{consumer}/keyauth) which will stop confusing users about the famous "API_ID" as a form parameter.
  • It now supports application/json Content Type. Kong/kong#236
  • It now supports PUT calls. Kong/kong#236
• Proxy
  • Support for path routing. Kong/kong#282
  • Support for alternate Host header: X-Host-Override. Kong/kong#246
  • Headers sent to the upstream server when using authentication plugins
• Plugins
  • HTTP logging docs. Kong/kong#244
  • File logging has a new option to specify a path to a file. Kong/kong#202
  • Document the SSL plugin, and SSL features. Kong/kong#254
  • Document the Analytics plugin. Kong/kong#272
  • Document the response transformations plugin.
  • Document the request size limiting plugin
• Chore
  • Document that openresty must be patched in the Source install for SSL support

Not related to 0.3.0, but still missing

• Document the default logging format.
• Document how the proxy layer works. #80 Also related to the new path routing and the new X-Host-Override header.

As mentioned in #10, we should redirect a request at /docs/{latest,current} to `/docs/x.x.x. This can only happen if we host getkong.org somewhere else of if we use something such as cloudflare.

Caveats:

• The process won't be automated

Or, during the website generation we can duplicate the content of the latest version into a new latest/current folder. It won't be redirects, but it'll be automated.

Caveats:

• It could impact SEO?