You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by me...@apache.org on 2020/03/18 00:48:05 UTC

[incubator-apisix] branch master updated: doc: adding getting started guide as the quick start guide (#1287)

This is an automated email from the ASF dual-hosted git repository.

membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 07a714e  doc: adding getting started guide as the quick start guide (#1287)
07a714e is described below

commit 07a714ee36db49efac647bc4b19dbfb3888528d5
Author: Nirojan Selvanathan <ss...@gmail.com>
AuthorDate: Wed Mar 18 01:47:55 2020 +0100

    doc: adding getting started guide as the quick start guide (#1287)
---
 README.md                |   5 ++---
 doc/getting-started.md   |  11 ++++++++++-
 doc/images/dashboard.png | Bin 0 -> 34304 bytes
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index aa42582..5e046a7 100644
--- a/README.md
+++ b/README.md
@@ -132,10 +132,9 @@ Steps to install APISIX:
 sudo apisix start
 ```
 
-2. try limit count plugin
+2. Try the getting started guide
 
-Limit count plugin is a good start to try APISIX,
-you can follow the [documentation of limit count](doc/plugins/limit-count.md).
+The getting-started guide is a good way to learn the basics of APISIX. Follow the [getting started guide](doc/getting-started.md).
 
 Then you can try more [plugins](doc/README.md#plugins).
 
diff --git a/doc/getting-started.md b/doc/getting-started.md
index 640226d..604ac4e 100644
--- a/doc/getting-started.md
+++ b/doc/getting-started.md
@@ -212,7 +212,7 @@ Use the command below to securely access the endpoint now.
 curl -i -X GET http://127.0.0.1:9080/get -H "Host: httpbin.org" -H 'apikey: superSecretAPIKey'
 ```
 
-## Add a prefix to the route (Optional)
+## Add a prefix to the route
 
 Now lets say you want to add a prefix (eg: samplePrefix) to the route and do not want to use the `host` header then you can use
 the proxy rewrite plugin to do it.
@@ -238,6 +238,15 @@ Now you can invoke the route with the following command:
 curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
 ```
 
+## APISIX Dashboard
+
+As of now the API calls to the APISIX has been orchestrated by using the Admin API. However, APISIX also provides
+a web application to perform the similar. The dashboard is available in the following
+[repository](https://github.com/apache/incubator-apisix). The dashboard is intuitive and you can orchestrate the
+same route configurations via the dashboard as well.
+
+![Dashboard](images/dashboard.png)
+
 ### Troubleshooting
 
 - Make sure the required ports are not being used by other systems/processes (The default ports are: 9080, 9443, 2379).
diff --git a/doc/images/dashboard.png b/doc/images/dashboard.png
new file mode 100644
index 0000000..de8f65b
Binary files /dev/null and b/doc/images/dashboard.png differ