Skip to content

Commit

Permalink
Merge pull request #69 from Mashape/site/cleanup
Browse files Browse the repository at this point in the history
Site/cleanup
  • Loading branch information
thibaultcha committed Mar 11, 2015
2 parents 8ed5e7b + 13c7633 commit daad0f8
Show file tree
Hide file tree
Showing 43 changed files with 211 additions and 240 deletions.
21 changes: 10 additions & 11 deletions site/app/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@

<!DOCTYPE html>
<html lang="en" itemscope itemtype="http://schema.org/Article">
{% include head.html %}

<body>
<div id="error">
<div class="container">
<h1>D'oh!</h1>
{% include head.html %}

<h2>Page Not Found.</h2>

<p><a href="/">&laquo; Return to home page</a></p>
</div>
</div>
</body>
<body>
<div id="error">
<div class="container">
<h1>D'oh!</h1>
<h2>Page Not Found.</h2>
<p><a href="/">&laquo; Return to home page</a></p>
</div>
</div>
</body>
</html>
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion site/app/_assets/stylesheets/pages/homepage.less
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
height: 450px;
text-align: left;
background-size: contain;
background: url("../assets/images/net/net-1x.png") no-repeat right center;
background: url("../assets/images/net-1x.png") no-repeat right center;
padding: 0;
}
}
Expand Down
1 change: 1 addition & 0 deletions site/app/_includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

<span>&copy; <strong>2015</strong>, <a href="https://mashape.com">Mashape</a></span>
<span class="mashape-footer-separator"></span>
<a href="/license">License</a>
<a href="/terms">Terms</a>
<a href="/privacy">Privacy</a>
</div>
Expand Down
15 changes: 15 additions & 0 deletions site/app/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<header class="page-header">
<div class="container">
{% if page.header_icon %}
<div class="page-header-icon">
<img src="{{ page.header_icon }}" alt="" />
</div>
{% endif %}
<div class="page-header-title">
<h2>{{ page.header_title }}</h2>
{% if page.header_caption %}
<p>{{ page.header_caption }}</p>
{% endif %}
</div>
</div>
</header>
3 changes: 2 additions & 1 deletion site/app/_includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
<span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button>
<nav id="navbar" class="navbar-nav">
<ul>
<li><a href="/plugins">Plugins</a></li>
<li><a href="/docs">Documentation</a></li>
<li><a href="/plugins">Plugins</a></li>
<li><a href="/contribute">Contribute</a></li>
<li><a href="/support">Support</a></li>
<li>
<div class="navbar-form"><a href="/download" class="button">Download</a></div>
Expand Down
18 changes: 8 additions & 10 deletions site/app/_includes/pages/contribute/contributing-to-codebase.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
**Repository**: [https://github.com/mashape/kong](https://github.com/mashape/kong)
**Repository**: {{site.repo}}

Make sure you have all the required dependencies installed, and that you understand how the Makefile works.

Please follow these formatting guidelines:

* Lua indent is 2 spaces Line width is 140 characters
* The rest is left to Lua coding standards
* Lua indent is 2 spaces
* Disable "auto-format on save" to prevent unnecessary format changes. This makes reviews much harder as it generates unnecessary formatting changes. If your IDE supports formatting only modified chunks, that is fine to do.

To create a distribution from the source, simply run:
Follow the instructions in the [repo's README]({{site.repo}}) to setup your development environment.

```bash
cd kong
make dev
```
Before submitting your changes, run the linter:

You will find the newly built development configuration under: ./config.dev/
```
make lint
```

Before submitting your changes, run the test suite to make sure that nothing is broken, with:
And the test suite to make sure that nothing is broken:

```bash
make test-all
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
**Repository**: [https://github.com/mashape/kong](https://github.com/mashape/kong) in the `/site/app/_includes/pages/` directory.
**Repository**: {{site.repo}} in the `/site/app/_includes/pages/` directory.

The entire website is maintained on GitHub in the `site` folder. You can run it by following the instructions at [https://github.com/Mashape/kong/blob/master/site/README.md](https://github.com/Mashape/kong/blob/master/site/README.md)
The entire website is maintained on GitHub in the `site` folder. You can run it by following the instructions at {{site.repo}}/blob/master/site/README.md

There is no need to create an issue for documentation changes. Summarising your changes in the pull request will suffice. Similarly, there are no documentation tests.
There is no need to create an issue for documentation changes. Summarising your changes in the pull request will suffice. Similarly, there are no documentation tests.
2 changes: 1 addition & 1 deletion site/app/_includes/pages/contribute/feature-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

If you find yourself wishing for a feature that doesn’t exist in Kong, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Kong has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

<a href="https://github.com/Mashape/kong/issues/new?title=[Feature%20Request]%20Your%20feature%20request%20here..." class="button button-primary button-large">Open an Issue in Github</a>
<a href="{{site.repo}}/issues/new?title=[Feature%20Request]%20Your%20feature%20request%20here..." class="button button-primary button-large" target="_blank">Open an issue in Github</a>
10 changes: 5 additions & 5 deletions site/app/_includes/pages/contribute/send-bug-reports.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Send Bug Reports

If you think you have found a bug in Kong, first make sure that you are testing against the [latest version of Kong](/download) &mdash; your issue may already have been fixed. If not, search our [issues list on GitHub](https://github.com/Mashape/kong/issues) in case a similar issue has already been opened.
If you think you have found a bug in Kong, first make sure that you are testing against the [latest version of Kong](/download) &mdash; your issue may already have been fixed. If not, search our [issues list on GitHub]({{site.repo}}/issues) in case a similar issue has already been opened.

It is very helpful if you can prepare a reproduction of the bug. In other words, provide a small test case which we can run to confirm your bug. It makes it easier to find the problem and to fix it. Test cases should be provided as curl commands which we can copy and paste into a terminal to run it locally, for example:

Expand All @@ -10,14 +10,14 @@ curl -XDELETE 127.0.0.1:8001/apis/a2e8fccf-96b2-46c0-c6dd-4d0e968660b7

# insert a new API
curl -XPOST 127.0.0.1:8001/apis/
-d 'name=HttpBin' \
-d 'public_dns=api.httpbin.org' \
-d 'target_url=http://httbin.org'
-d 'name=Mockbin' \
-d 'public_dns=api.mockbin.com' \
-d 'target_url=http://mockbin.com'

# this should return XXXX but instead returns YYY
curl ...
```

Provide as much information as you can. You may think that the problem lies with your query, when actually it depends on how your data is stored. The easier it is for us to recreate your problem, the faster it is likely to be fixed.

<a href="https://github.com/Mashape/kong/issues/new" class="button button-primary button-large">Report a Bug in Github</a>
<a href="{{site.repo}}/issues/new" class="button button-primary button-large" target="_blank">Report a bug in Github</a>
6 changes: 2 additions & 4 deletions site/app/_includes/pages/docs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Overview
## What is Kong?

Welcome to the Kong official documentation, that will help you setting up Kong, configuring it and operating it. We reccomend reading every section of this document to have a full understanding of the project.

If you have more specific questions about Kong, please join us on [Gitter][gitter-url] and the project maintainers will be happy to answer any of your questions.

## What is Kong?

Kong is a scalable, lightweight, open source API Layer (also called *API Gateway* or *API Middleware*) that runs in front of any RESTful API and provides additional functionalities to the underlying APIs.

APIs running behind Kong can be empowered with [Kong plugins](#plugins) that provide extra functionality and services beyond the core Kong platform. Some of the most popular plugins are: authentication, rate limiting, logging, and more. You can also build your own plugins that other people can use on top of their Kong installation.
Expand Down Expand Up @@ -56,7 +54,7 @@ Kong Server requires Apache Cassandra running alongside the Proxy Server. It is

Cassandra has been chosen because is easy to scale up and down just by adding or removing nodes, and because it can be deployed in lots of different environments, from a single machine to a multi-datacenter cluster.

#Run it for the first time
# Run it for the first time

Running Kong is very easy and will take a couple of minutes. To get started quickly choose between one of the following deployment options:

Expand Down
4 changes: 2 additions & 2 deletions site/app/_includes/pages/download/centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
wget http://getkong.org/releases/kong-0.0.1-beta.tar.gz
tar xvzf kong-0.0.1-beta.tar.gz
```

2. Install dependencies:

```bash
wget http://luarocks.com
./configure && make && make install
```

2. Run:

```bash
bin/kong migrate # Only the first time
bin/kong start
```

Something went wrong? [Check Out the Docs](/docs)
4 changes: 2 additions & 2 deletions site/app/_includes/pages/download/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
wget http://getkong.org/releases/kong-0.0.1-beta.tar.gz
tar xvzf kong-0.0.1-beta.tar.gz
```

2. Install dependencies:

```bash
wget http://luarocks.com
./configure && make && make install
```

2. Run:

```bash
bin/kong migrate # Only the first time
bin/kong start
```

Something went wrong? [Check Out the Docs](/docs)
4 changes: 2 additions & 2 deletions site/app/_includes/pages/download/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
wget http://getkong.org/releases/kong-0.0.1-beta.tar.gz
tar xvzf kong-0.0.1-beta.tar.gz
```

2. Install dependencies:

```bash
wget http://luarocks.com
./configure && make && make install
```

2. Run:

```bash
bin/kong migrate # Only the first time
bin/kong start
```

Something went wrong? [Check Out the Docs](/docs)
4 changes: 2 additions & 2 deletions site/app/_includes/pages/download/osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
wget http://getkong.org/releases/kong-0.0.1-beta.tar.gz
tar xvzf kong-0.0.1-beta.tar.gz
```

2. Install dependencies:

```bash
wget http://luarocks.com
./configure && make && make install
```

2. Run:

```bash
bin/kong migrate # Only the first time
bin/kong start
```

Something went wrong? [Check Out the Docs](/docs)
8 changes: 4 additions & 4 deletions site/app/_includes/pages/download/zip.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
### .Zip / Tar.gz
### .zip / tar.gz

1. Get the files: ( [Zip](#) | [Tar.gz](#) )
1. Get the files: ( [zip](#) | [tar.gz](#) )

```bash
wget http://getkong.org/releases/kong-0.0.1-beta.tar.gz
tar xvzf kong-0.0.1-beta.tar.gz
```

2. Install dependencies:

```bash
wget http://luarocks.com
./configure && make && make install
```

2. Run:

```bash
bin/kong migrate # Only the first time
bin/kong start
```

Something went wrong? [Check Out the Docs](/docs)
33 changes: 15 additions & 18 deletions site/app/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
<!DOCTYPE html>
<html lang="en" itemscope itemtype="http://schema.org/Article">
{% include head.html %}
<body id="{{ page.id }}">
{% include nav.html %}

{{ content }}

{% include footer.html %}

<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="//www.parsecdn.com/js/parse-1.3.5.min.js"></script>
<script src="/assets/app.js?v={{site.time}}"></script>
<script type="text/javascript">
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1";
analytics.load("WDj0nSS7hpyxwL3evgbOzK755s0NUye6");
analytics.page()
}}();
</script>
</body>
{% include head.html %}
<body id="{{ page.id }}">
{% include nav.html %}
{{ content }}
{% include footer.html %}
<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="//www.parsecdn.com/js/parse-1.3.5.min.js"></script>
<script src="/assets/app.js?v={{site.time}}"></script>
<script type="text/javascript">
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1";
analytics.load("WDj0nSS7hpyxwL3evgbOzK755s0NUye6");
analytics.page()
}}();
</script>
</body>
</html>
16 changes: 5 additions & 11 deletions site/app/contribute/index.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
---
title: Contribute
sitemap: true
header_title: Contribute to Kong
header_icon: /assets/images/icons/icn-developers.svg
---

<div class="page page-contribute">
<header class="page-header">
<div class="container">
<div class="page-header-icon">
<img src="/assets/images/icons/03-icn-developers.svg" alt=""/>
</div>
<div class="page-header-title">
<h2>Contribute to Kong</h2>
</div>
</div>
</header>

{% include header.html %}

<div class="content">
<section>
Expand Down Expand Up @@ -49,4 +43,4 @@ <h3>
</div>
</section>
</div>
</div>
</div>
8 changes: 8 additions & 0 deletions site/app/docs/api/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: API Documentation
sitemap: true
---

{% include header.html %}

<h1>Hello World</h1>
Loading

0 comments on commit daad0f8

Please sign in to comment.