Skip to content

Commit

Permalink
dropping guide subdirectory
Browse files Browse the repository at this point in the history
  • Loading branch information
bismark committed Jun 16, 2014
1 parent 1c46bdd commit 78cb724
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 28 deletions.
2 changes: 1 addition & 1 deletion INSTALL.md
@@ -1 +1 @@
see site/guide/install.md
see http://switchboard.spatch.co/install
6 changes: 3 additions & 3 deletions readme.md
Expand Up @@ -9,11 +9,11 @@ process emails as they arrive.
## Documentation

See the
[guide](http://switchboard.spatch.co)
[site](http://switchboard.spatch.co)
for
[Installation](http://switchboard.spatch.co/guide/install/)
[Installation](http://switchboard.spatch.co/install/)
and
[Getting Started](http://switchboard.spatch.co/guide/whatis/)
[Getting Started](http://switchboard.spatch.co/whatis/)
instructions, as well as other topics.

You're more than welcome to [contribute](CONTRIBUTING.md).
Expand Down
2 changes: 1 addition & 1 deletion site/_config.yml
Expand Up @@ -14,6 +14,6 @@ highlighter: pygments
defaults:
-
scope:
path: "guide"
path: ""
values:
layout: "guide"
12 changes: 6 additions & 6 deletions site/_includes/guidenav.html
@@ -1,11 +1,11 @@
<div class="sidebar">
<h2><ul>
<li><a class="{% if page.url contains '/guide/whatis' %}active{% endif %}" href="{{site.baseurl}}/guide/whatis">What is Switchboard</a></li>
<li><a class="{% if page.url contains '/guide/install' %}active{% endif %}" href="{{site.baseurl}}/guide/install">Installation</a></li>
<li><a class="{% if page.url contains '/guide/interfaces' %}active{% endif %}" href="{{site.baseurl}}/guide/interfaces">Worker and Client Interfaces</a></li>
<li><a class="{% if page.url contains '/guide/examples' %}active{% endif %}" href="{{site.baseurl}}/guide/examples">Examples</a></li>
<li><a class="{% if page.url contains '/guide/contributing' %}active{% endif %}" href="{{site.baseurl}}/guide/contributing">Contributing</a></li>
<li><a class="{% if page.url contains '/whatis' %}active{% endif %}" href="{{site.baseurl}}/whatis">What is Switchboard</a></li>
<li><a class="{% if page.url contains '/install' %}active{% endif %}" href="{{site.baseurl}}/install">Installation</a></li>
<li><a class="{% if page.url contains '/interfaces' %}active{% endif %}" href="{{site.baseurl}}/interfaces">Worker and Client Interfaces</a></li>
<li><a class="{% if page.url contains '/examples' %}active{% endif %}" href="{{site.baseurl}}/examples">Examples</a></li>
<li><a class="{% if page.url contains '/contributing' %}active{% endif %}" href="{{site.baseurl}}/contributing">Contributing</a></li>
<li><a target="_blank" href="{{site.baseurl}}/doc">API Docs</a></li>
<li><a class="{% if page.url contains '/guide/faq' %}active{% endif %}" href="{{site.baseurl}}/guide/faq">FAQ</a></li>
<li><a class="{% if page.url contains '/faq' %}active{% endif %}" href="{{site.baseurl}}/faq">FAQ</a></li>
</ul></h2>
</div>
2 changes: 1 addition & 1 deletion site/_includes/header.html
Expand Up @@ -5,7 +5,7 @@

<div class="menu">
<ul>
<li><a class="{% if page.url contains '/guide' %}active{% endif %}" href="{{site.baseurl}}/guide/install">Getting Started</a></li>
<li><a class="{% if page.url contains '/guide' %}active{% endif %}" href="{{site.baseurl}}/install">Getting Started</a></li>
<li><a class="{% if page.url contains '/about' %}active{% endif %}" href="{{site.baseurl}}/about">About</a></li>
<li class="github"><a href="https://github.com/thusfresh/switchboard">Github</a></li>
</ul>
Expand Down
4 changes: 1 addition & 3 deletions site/about.md
Expand Up @@ -7,9 +7,7 @@ layout: page
*Switchboard* was born out of our (the [Spatch](http://spatch.co)
team) need for a cloud based email processing framework. We started
working in early 2014 with [Thomas Moulia](http://pocketknife.io) who
let the architecting and development process. Switchboard is a
framework for managing connections across IMAP providers and exposes a
simple client API for creating plugins. In June 2014, we made
led the architecting and development process. In June 2014, we made
Switchboard available as open source project with the aim to free
developers from the plumbing of server-side email processing, allowing
them to focus on creating innovative and useful email plugins. We
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion site/guide/examples.md → site/examples.md
Expand Up @@ -67,7 +67,7 @@ attachments from a user's emails to his or her Dropbox.
#### Setup

First off, make sure switchboard is running on your local server (see
[Switchboard Installation](/switchboard/guide/install/
[Switchboard Installation](/switchboard/install/
"Installation") for details)

After the Switchboard server is up, you're ready to start building
Expand Down
2 changes: 1 addition & 1 deletion site/guide/faq.md → site/faq.md
Expand Up @@ -12,7 +12,7 @@ personal use, great care should be taken to ensure that both
Switchboard and its environment are secure.

When deploying Switchboard, you *must* understand the differences
between the [worker and client](/guide/interfaces) interfaces. Unless
between the [worker and client](/interfaces) interfaces. Unless
you have a good reason otherwise, the worker interface should
never be publicly exposed.

Expand Down
File renamed without changes.
4 changes: 0 additions & 4 deletions site/guide/.frontmatter

This file was deleted.

4 changes: 2 additions & 2 deletions site/index.html
Expand Up @@ -7,7 +7,7 @@ <h1>Email processing.<br>Check.</h1>
<div class="line"></div>
<h3>Switchboard handles the boilerplate of server-side<br>email processing,
leaving you free to create the logic.<br><b>Forever open source</b>.</h3>
<div class="button"><a href="{{site.baseurl}}/guide/install">GETTING STARTED</a></div>
<div class="button"><a href="{{site.baseurl}}/install">GETTING STARTED</a></div>
</div>

<div class="gradient">
Expand Down Expand Up @@ -107,5 +107,5 @@ <h3>Comprehensive docs</h3>
</div>

<div class="text-center button buttonBottom">
<a href="{{site.baseurl}}/guide/install">GETTING STARTED</a>
<a href="{{site.baseurl}}/install">GETTING STARTED</a>
</div>
4 changes: 2 additions & 2 deletions site/guide/install.md → site/install.md
Expand Up @@ -20,7 +20,7 @@ startup/control script. You can run it without arguments to see a list
of its commands.

Because you won't be building Switchboard forom source, the
[worker/client section]({{site.baseurl}}/guide/interfaces) will
[worker/client section]({{site.baseurl}}/interfaces) will
probably be most interesting to you next. Check out the
[Switchboard Erlang API]({{site.baseurl}}/doc) or
[example]({{site.baseurl}}/buide/example) section for directions on
Expand Down Expand Up @@ -64,4 +64,4 @@ make
Please create an issue if there were any problems.

Next up:
[worker and client interfaces]({{site.baseurl}}/guide/interfaces).
[worker and client interfaces]({{site.baseurl}}/interfaces).
2 changes: 1 addition & 1 deletion site/guide/interfaces.md → site/interfaces.md
Expand Up @@ -266,4 +266,4 @@ S: [["messages", {"state": "TODO",
}]}]]
{% endhighlight %}

Next up: [examples]({{site.baseurl}}/guide/examples).
Next up: [examples]({{site.baseurl}}/examples).
4 changes: 2 additions & 2 deletions site/guide/whatis.md → site/whatis.md
Expand Up @@ -65,10 +65,10 @@ take you from installation, to setting up a Switchboard worker or
client.

To get Switchboard up and running, take a look at the
[install]({{site.baseurl}}/guide/install) pages.
[install]({{site.baseurl}}/install) pages.

To see an example of how Switchboard can be used, see the
[Examples]({{site.baseurl}}/guide/examples) pages with examples and
[Examples]({{site.baseurl}}/examples) pages with examples and
walkthroughs on:

<ul class="bulletPoints1">
Expand Down

0 comments on commit 78cb724

Please sign in to comment.