Skip to content

Commit

Permalink
Add rough website outline
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesroutley committed May 15, 2017
1 parent 64bc5cc commit 3ecf9cc
Show file tree
Hide file tree
Showing 24 changed files with 1,196 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,11 @@ Temporary Items

## File-based project format:
*.iws

# Jekyll settings

.bundle/
website/vendor/*
_site/
.sass-cache/
.jekyll-metadata
28 changes: 28 additions & 0 deletions website/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
source "https://rubygems.org"
ruby RUBY_VERSION

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "3.4.3"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.0"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

57 changes: 57 additions & 0 deletions website/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
colorator (1.1.0)
ffi (1.9.18)
forwardable-extended (2.6.0)
jekyll (3.4.3)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-feed (0.9.2)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
minima (2.1.1)
jekyll (~> 3.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
rb-fsevent (0.9.8)
rb-inotify (0.9.8)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.23)

PLATFORMS
ruby

DEPENDENCIES
jekyll (= 3.4.3)
jekyll-feed (~> 0.6)
minima (~> 2.0)
tzinfo-data

RUBY VERSION
ruby 2.4.1p111

BUNDLED WITH
1.14.6
35 changes: 35 additions & 0 deletions website/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Your awesome title
email: your-email@domain.com
description: > # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: jekyllrb
github_username: jekyll

# Build settings
markdown: kramdown
# theme: minima
gems:
- jekyll-feed
exclude:
- Gemfile
- Gemfile.lock
- vendor
12 changes: 12 additions & 0 deletions website/_includes/docs_navigation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<div class="spt-docs-nav">
<ul>
<li><a href="/docs/install.html">Installation</a></li>
<li><a href="/docs/terminology.html">Terminology</a></li>
<li><a href="/docs/cli.html">Commands (CLI)</a></li>
<li><a href="/docs/environment_config.html">Environment Config</a></li>
<li><a href="/docs/stack_config.html">Stack Config</a></li>
<li><a href="/docs/templates.html">Templates</a></li>
<li><a href="/docs/advanved_patterns.html">Advanced Patterns</a></li>
<li><a href="/docs/faq.html">FAQ</a></li>
</ul>
</div>
10 changes: 10 additions & 0 deletions website/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@


<footer>
<hr>
<div class="container">
<div class="col-md-6">
<p>bla</p>
</div>
</div>
</footer>
5 changes: 5 additions & 0 deletions website/_includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<head>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="/assets/css/sceptre.css">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
14 changes: 14 additions & 0 deletions website/_includes/navbar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<nav class="navbar navbar-static-top navbar-default">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="/index.html">Sceptre</a>
</div>

<ul class="nav navbar-nav navbar-right">
<li><a href="/intro">Intro</a></li>
<li><a href="/guide">Guide</a></li>
<li><a href="/docs/index">Docs</a></li>
<li><a href="https://github.com/cloudreach/sceptre">GitHub</a></li>
</ul>
</div>
</nav>
17 changes: 17 additions & 0 deletions website/_layouts/docs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html>
{% include head.html %}
<body>
{% include navbar.html %}
<div class="container">
<div class="col-md-3">
{% include docs_navigation.html %}
</div>
<div class="col-md-9">
{{ content }}
</div>
</div>
{% include footer.html %}
</body>

</html>
11 changes: 11 additions & 0 deletions website/_layouts/home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
{% include head.html %}
<body>
{% include navbar.html %}
<div class="container">
{{ content }}
</div>
</body>

</html>
14 changes: 14 additions & 0 deletions website/_layouts/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html>

{% include head.html %}

<body>
{% include navbar.html %}
<div class="container">
{{ content }}
</div>
{% include footer.html %}
</body>

</html>
40 changes: 40 additions & 0 deletions website/assets/css/sceptre.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
@import url('https://fonts.googleapis.com/css?family=Slabo');

h1,
h2,
h3,
h4,
h5,
h6 {
/*font-family: slabo;*/
}

.navbar {
background-color: #fff;
border-bottom-color: #000;
padding: 25px;
}

.navbar-default .navbar-brand {
color: #000;
}

.navbar-default .navbar-nav>li>a {
color: #000;
}

.navbar-default .navbar-nav>li>a:hover {
color: #00600f;
}

.spt-docs-nav {
margin-top: 70px;
}

footer {
border-top-width: 2px;
border-top-color: #000;
/*background-color: #e0e0e0;*/
margin-top: 70px;
padding: 50px;
}
Empty file.
83 changes: 83 additions & 0 deletions website/docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
layout: docs
---

## Command Line Interface

Sceptre can be used as a command line tool. Sceptre commands take the format:

```
$ sceptre [GLOBAL_OPTIONS] COMMAND [ARGS] [COMMAND_OPTIONS]
```

Running sceptre without a subcommand will display help, showing a list of the available commands.

## Global Options

`--debug`: Turn on debug logging.

`--dir`: Specify the sceptre directory with an absolute or relative path.

`--no-colour`: Disable coloured output.

`--output`: Specify the output format. Available formats: `[yaml, json]`.

`--var`: Overwrite an arbitrary config item. For more information, see the section on :ref:`templating`.

`--var-file`: Overwrite arbitrary config item(s) with data from a variables file. For more information, see the section on :ref:`templating`.


## Commands

The available commands are:

```
$ sceptre continue-update-rollback
$ sceptre create-change-set
$ sceptre create-stack
$ sceptre delete-change-set
$ sceptre delete-env
$ sceptre delete-stack
$ sceptre describe-change-set
$ sceptre describe-env
$ sceptre describe-env-resources
$ sceptre describe-stack-outputs
$ sceptre describe-stack-resources
$ sceptre execute-change-set
$ sceptre generate-template
$ sceptre get-stack-policy
$ sceptre launch-env
$ sceptre launch-stack
$ sceptre list-change-sets
$ sceptre lock-stack
$ sceptre set-stack-policy
$ sceptre unlock-stack
$ sceptre update-stack
$ sceptre update-stack-cs
$ sceptre validate-template
```


## Command Options

Command options differ depending on the command, and can be found by running:

```
$ sceptre COMMAND --help
```


## Export Stack Outputs to Environment Variables

Stack outputs can be exported as environment variables with the command:

```shell
$ eval $(sceptre describe-stack-outputs ENVIRONMENT STACK --export=envvar)
```

Note that Sceptre prepends the string `SCEPTRE_` to the name of the environment variable:

```shell
$ env | grep SCEPTRE
SCEPTRE_<output_name>=<output_value>
```

0 comments on commit 3ecf9cc

Please sign in to comment.