Skip to content

Commit

Permalink
Move get started to docs, rename intro to about
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesroutley committed Jul 12, 2017
1 parent 4d9c086 commit 0eb93e3
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 7 deletions.
4 changes: 4 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ This directory contains the code for Sceptre's [website](https://sceptre.cloudre

The website is written using the [Jekyll](https://jekyllrb.com) framework.

## Ruby

Jekyll depends on Ruby. Documentation on installing Ruby can be found [here](https://www.ruby-lang.org/en/documentation/installation/).

## Install Jekyll

Jekyll and its dependencies can be installed with:
Expand Down
1 change: 1 addition & 0 deletions website/_includes/docs_navigation.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<div class="spt-docs-nav">
<ul>
<li><a href="{{ site.baseurl }}/docs/install.html">Installation</a></li>
<li><a href="{{ site.baseurl }}/docs/get_started.html">Get Started</a></li>
<li><a href="{{ site.baseurl }}/docs/terminology.html">Terminology</a></li>
</ul>
<hr>
Expand Down
3 changes: 1 addition & 2 deletions website/_includes/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="collapsable-navbar">
<ul class="nav navbar-nav navbar-right">
<li><a href="{{ site.baseurl }}/intro.html">Intro</a></li>
<li><a href="{{ site.baseurl }}/guide.html">Guide</a></li>
<li><a href="{{ site.baseurl }}/about.html">About</a></li>
<li><a href="{{ site.baseurl }}/docs/index.html">Docs</a></li>
<li><a href="https://github.com/cloudreach/sceptre">GitHub</a></li>
</ul>
Expand Down
3 changes: 1 addition & 2 deletions website/intro.md → website/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
---

# Introduction
# About

Sceptre is a tool to drive Cloudformation. Sceptre manages the creating, updating and deletion of stacks, and provides meta commands to allow users to get information about their stacks. Sceptre is unopinionated, enterprise ready and designed to be run as part of CI/CD pipelines. Sceptre is accessible as a CLI tool, or as a Python module.

Expand All @@ -26,4 +26,3 @@ For a tutorial on using Sceptre, see [Get Started]({{ site.baseurl }}/guide.html
Sceptre's source code can be found on [Github](https://github.com/cloudreach/sceptre/).

Bugs and feature requests should be raised via our [Issues](https://github.com/cloudreach/sceptre/issues) page.

2 changes: 1 addition & 1 deletion website/guide.md → website/docs/get_started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: page
layout: docs
---

# Get Started
Expand Down
2 changes: 1 addition & 1 deletion website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ layout: docs

This documentation acts as an in-depth reference for all of Sceptre's features.

Beginners should consider reading our [getting started guide]({{ site.url }}{{ site.baseurl }}/guide.html), which provides a walk-through tutorial.
Beginners should consider reading our [getting started guide]({{ site.url }}{{ site.baseurl }}/docs/get_started.html), which provides a walk-through tutorial.
2 changes: 1 addition & 1 deletion website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
<div class="col-md-8 col-md-offset-2">
<h1>Sceptre</h1>
<p>Automate cloud deployments</p>
<a href="{{ site.baseurl }}/intro.html">Learn more >></a>
<a href="{{ site.baseurl }}/about.html">Learn more >></a>
</div>

0 comments on commit 0eb93e3

Please sign in to comment.