Merge pull request #75 from microservices-demo/fix-documentation-links

Fix documentation links

Author: pidster

404.html

@@ -85,7 +85,7 @@ <h3><a id="user-content-visualizing-the-application" class="anchor" href="#visua
 -->
 
       <div class="footer">
-        <p>&copy;2016 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
+        <p>&copy;2017 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
       </div>
 
     </div>

README.md

@@ -1,5 +1,15 @@
-This directory contains the deployment and internal documentation.
+microservices-demo documentation
+================================
 
-Both are published on https://microservices-demo.github.io/microservices-demo/.
+> This directory contains the deployment and internal documentation.
+It is published at [microservices-demo.github.io](https://microservices-demo.github.io)
 
-There is a docker-compose included for local development. Note that it mounts `_config.yml.dev` in the place of `_config.yml`, to enable local linking.
+
+## Getting started
+
+There is a [docker-compose](https://docs.docker.com/compose/) included for
+local development, use the following command to start it:
+
+```
+docker-compose up
+```

_config.yml

@@ -1,9 +1,3 @@
-# Production settings
-
-baseurl: ""
-deploy_doc_url_prefix: https://microservices-demo.github.io/microservices-demo
-main_url_prefix: https://microservices-demo.github.io
-
 # Build settings
 markdown: kramdown
 exclude:

_config.yml.dev

@@ -1,11 +1,11 @@
 <div class="header clearfix">
-<div class="header-home"><a href="{{site.main_url_prefix}}/">Sock Shop</a></div>
+<div class="header-home"><a href="/">Sock Shop</a></div>
 <nav>
   <ul class="nav header-nav">
     <li class="{% if include.quickstart %}active{% endif %}"><a href="/docs/quickstart.html">Quickstart</a></li>
     <li class="{% if include.docs %}active{% endif %}"><a href="/docs/index.html">Docs</a></li>
     <li class="{% if include.api %}active{% endif %}"><a href="/api/index.html">API</a></li>
-    <li><a href="http://github.com/microservices-demo" target="_blank">GitHub</a></li>
+    <li><a href="https://github.com/microservices-demo" target="_blank">GitHub</a></li>
   </ul>
 </nav>
 </div>

_includes/header.html

@@ -45,7 +45,7 @@ <h1>API</h1>
       </div>
 
       <div class="footer">
-        <p>&copy;2016 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
+        <p>&copy;2017 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
       </div>
     </div>
 

_layouts/api.html

@@ -39,7 +39,7 @@ <h1>Documentation</h1>
       </div>
 
       <div class="footer">
-        <p>&copy;2016 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
+        <p>&copy;2017 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
       </div>
 
     </div>

_layouts/default.html

@@ -26,7 +26,7 @@
 
       <div class="inner">
         <h1>Documentation</h1>
-        
+
         <div class="row">
           <div class="col-sm-3">
             {% include doc_menu.html %}
@@ -39,7 +39,7 @@ <h1>Documentation</h1>
       </div>
 
       <div class="footer">
-        <p>&copy;2016 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
+        <p>&copy;2017 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
       </div>
 
     </div>

_layouts/quickstart.html

@@ -60,7 +60,7 @@ code.highlighter-rouge {
   font-weight: bold;
   margin: 0.3em 0 0;
   padding: 0 0 0 30px;
-  background-image: url({{ site.deploy_doc_url_prefix }}/assets/img/weaveworks-logo.png);
+  background-image: url(/assets/img/weaveworks-logo.png);
   background-repeat: no-repeat;
   background-position-y: 0.3em;
   background-size: 1em 1em;
@@ -95,7 +95,7 @@ code.highlighter-rouge {
 }
 
 .hero-banner {
-  background: url(../img/hero_socks.png);
+  background: url(/assets/img/hero_socks.png);
   margin: 0 0 2em;
 }
 

assets/css/custom.scss

@@ -13,4 +13,3 @@ services:
       - 4000:4000
     volumes:
       - .:/srv/jekyll
-      - $PWD/_config.yml.dev:/srv/jekyll/_config.yml

docker-compose.yml

@@ -113,7 +113,7 @@ <h3><a id="user-content-visualizing-the-application" class="anchor" href="#visua
       </div>
 
       <div class="footer">
-        <p>&copy;2016 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
+        <p>&copy;2017 <a href="http://weave.works/" target="_blank">Weaveworks, Inc</a></p>
       </div>
 
     </div>

index.html

@@ -19,7 +19,9 @@ This explains how to deploy the Sock Shop onto any existing Kubernetes cluster.
 
 1. [Clone the microservices-demo repository](https://github.com/microservices-demo/microservices-demo)
 2. Go to the *deploy/kubernetes* folder
-    ```
-    kubectl create namespace sock-shop
-    kubectl apply -f complete-demo.yaml
-    ```
+
+```
+kubectl create namespace sock-shop
+
+kubectl apply -f complete-demo.yaml
+```