Documentation

[nijikokun]

Core

• Installation as defined under Better installation documentation #126
  • Configuration
  • Update Ubuntu commands
  • Update Debian commands
• Overview
  • Guide "boxes" that point to different locations in the documentation
• Welcome to Kong
• Getting Started / Introduction
  • Thirty second quickstart with Kong
  • Adding APIs
  • Enabling Plugins
  • Adding Consumers
  • Future: Adding nodes to your Kong cluster
• Migrations
• Plugins
• Binary / CLI API
• RESTful API

Plugins

Minimum required documentation for all plugins:

• Name

• Tagline

• Installing

• Configuration (including usage commands)

• Usage (how it affects API(s) / Consumer(s), and examples of usage)

  Examples of usage are for example take the keyauth plugin which adds authentication that can be used in multiple places such as the header, querystring, or form parameter:

  Using the keyauth plugin as a header:

  curl -i -X GET \
     --url http://localhost:8000/ \
     --header 'Host: mockbin.com' \
     --header '<key_name>: <key>'

  Where key_name is a value defined in value.key_names, and key is a key created with a POST request to /keyauth_credentials/

• Explanation of each feature (how does keyauth differ from basicauth)

[nijikokun]

Perhaps should move plugin documentation requirements to a wiki page, thoughts @thibaultcha and @thefosk ?

[orliesaurus]

• Update Ubuntu commands to add Kong with sudo in two steps

echo "deb [arch=amd64] http://mashape-kong-apt-repo.s3-website-us-east-1.amazonaws.com/ubuntu/12_04/ kong main" | sudo tee -a /etc/apt/sources.list

and

echo "deb [arch=amd64] http://mashape-kong-apt-repo.s3-website-us-east-1.amazonaws.com/ubuntu/14_04/ kong main" | sudo tee -a /etc/apt/sources.list

[thibaultcha]

CLI API: Kong/docs.konghq.com#31. Which could also contain configuration (see the PR)

[thibaultcha]

This issue should probably be in getkong.org. Or closed and reopened as a smaller version there.

[nijikokun]

This has been completed 👍