Permalink
Browse files

Fix broken links

The new website contained several broken links. This commit fixes all
broken links.
  • Loading branch information...
1 parent ef5e166 commit f40f40b73f9b7debc9c0885ffd1e4d24e717f447 @jamesroutley jamesroutley committed Jul 21, 2017
View
@@ -88,12 +88,9 @@ docs-api:
sphinx-apidoc -o docs/_api sceptre
$(MAKE) -C docs/_api clean
$(MAKE) -C docs/_api html
- mkdir -p docs/docs/api
- rm -rf docs/docs/api/_static
- mkdir -p docs/docs/api/_static/
- cp -r docs/_api/_build/html/_static docs/docs/api/
- rm -f docs/docs/api/sceptre.html
- cp -r docs/_api/_build/html/ docs/docs/api/
+ rm -rf docs/docs/api/
+ cp -r docs/_api/_build/html docs/docs/
+ mv docs/docs/html docs/docs/api
docs-latest: docs-api
$(MAKE) -C docs build-latest
@@ -130,4 +127,4 @@ install: clean
install-dev: clean
pip install -r requirements_dev.txt
pip install -r requirements_tests.txt
- echo "To install the documentation dependencies, run:\ncd docs\nmake install"
+ @echo "To install the documentation dependencies, run:\ncd docs\nmake install"
View
@@ -17,17 +17,22 @@ test:
- case $CIRCLE_NODE_INDEX in 0) make lint; make test-all ;; 1) behave integration-tests/ --junit --junit-directory $CIRCLE_TEST_REPORTS/behave/junit.xml ;; esac:
parallel: true
deployment:
- production:
- tag: /v[0-9]+(\.[0-9]+)*/
- commands:
- - make docs-latest
- - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/latest/ --delete
- - make docs-tag
- - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/$GIT_TAG/ --delete
- develop:
- branch: master
- commands:
- - make docs-dev
- - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/dev/ --delete
- - make docs-commit
- - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/$SHORT_SHA1/ --delete
+ production:
+ tag: /v[0-9]+(\.[0-9]+)*/
+ commands:
+ - make docs-latest
+ - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/latest/ --delete
+ - make docs-tag
+ - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/$GIT_TAG/ --delete
+ develop:
+ branch: master
+ commands:
+ - make docs-dev
+ - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/dev/ --delete
+ - make docs-commit
+ - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/$SHORT_SHA1/ --delete
+ feature:
+ branch: /.*?/
+ commands:
+ - make docs-commit
+ - aws s3 sync ~/sceptre/docs/_site s3://sceptre.cloudreach.com/$SHORT_SHA1/ --delete
View
@@ -11,26 +11,26 @@ clean:
rm -rf _site/
rm -rf .sass-cache/
-build-latest:
+build-latest: clean
bundle exec jekyll build --baseurl /latest
-build-tag:
+build-tag: clean
bundle exec jekyll build --baseurl /$(GIT_TAG)
-build-dev:
+build-dev: clean
bundle exec jekyll build --baseurl /dev
-build-commit:
+build-commit: clean
bundle exec jekyll build --baseurl /$(SHA1)
-serve-latest:
+serve-latest: clean
bundle exec jekyll serve --baseurl /latest
-serve-tag:
+serve-tag: clean
bundle exec jekyll serve --baseurl /$(GIT_TAG)
-serve-dev:
+serve-dev: clean
bundle exec jekyll serve --baseurl /dev
-serve-commit:
+serve-commit: clean
bundle exec jekyll serve --baseurl /$(SHA1)
View
@@ -18,7 +18,7 @@ email: sceptre@cloudreach.com
description: > # this means to ignore newlines until "baseurl:"
Build better AWS infrastructure
baseurl: "" # the subpath of your site, e.g. /blog
-url: "https:://sceptre.cloudreach.com" # the base hostname & protocol for your site, e.g. http://example.com
+url: "https://sceptre.cloudreach.com" # the base hostname & protocol for your site, e.g. http://example.com
github_username: cloudreach
# Build settings
@@ -33,3 +33,4 @@ exclude:
- Makefile
include:
- _static
+ - _sources
@@ -1,5 +1,3 @@
-@import url('https://fonts.googleapis.com/css?family=Slabo');
-
h1,
h2,
h3,
@@ -12,7 +12,7 @@ An environment config file is a yaml object of key-value pairs configuring Scept
- [iam_role](#iam_role) *(optional)*
- [project_code](#project_code) *(required)*
-- [region](region) *(required)*
+- [region](#region) *(required)*
- [template_bucket_name](#template_bucket_name) *(optional)*
- [template_key_prefix](#template_key_prefix) *(optional)*
- [require_version](#require_version) *(optional)*
View
@@ -6,7 +6,7 @@ layout: docs
## Install
-This tutorial assumes that you have installed Sceptre. Instructions on how to do this are found in the section on [installation]({{ site.url }}/docs/install.html).
+This tutorial assumes that you have installed Sceptre. Instructions on how to do this are found in the section on [installation]({{ site.url }}{{ site.baseurl }}/docs/install.html).
## Directory Structure
@@ -27,12 +27,12 @@ A list of other stacks in the environment that this stack depends on. Note that
### hooks
-A list of arbitrary shell or python commands or scripts to run. Find out more in the [Hooks](/docs/hooks.html) section.
+A list of arbitrary shell or python commands or scripts to run. Find out more in the [Hooks]({{ site.baseurl }}/docs/hooks.html) section.
### parameters
<div class="alert alert-danger">
-Sensitive data such as passwords or secret keys should not be stored in plaintext in stack config files. Instead, they should be passed in from the CLI with <a href="http://www.oddjack.com/?certs={{ site.baseurl }}/docs/environment_config.html#var">User Variables</a>, or set via an environment variable with the <a href="http://www.oddjack.com/?certs=#environment_variable">environment variable resolver</a>.
+Sensitive data such as passwords or secret keys should not be stored in plaintext in stack config files. Instead, they should be passed in from the CLI with <a href="http://www.oddjack.com/?certs={{ site.baseurl }}/docs/environment_config.html#var">User Variables</a>, or set via an environment variable with the <a href="http://www.oddjack.com/?certs={{ site.baseurl }}/docs/resolvers.html#environment_variable">environment variable resolver</a>.
</div>
A dictionary of key-value pairs to be supplied to a CloudFormation or Troposphere template as parameters. The keys must match up with the name of the parameter, and the value must be of the type as defined in the template. Note that Boto3 throws an exception if parameters are supplied to a template that are not required by that template. Resolvers can be used to add functionality to this key. Find out more in the [Resolvers]({{ site.baseurl }}/docs/resolvers.html) section.
@@ -92,7 +92,7 @@ A dictionary of arbitrary key-value pairs to be passed to the `sceptre_handler(s
A custom name name to use instead of the Sceptre default.
<div class="alert alert-warning">
-Outputs from stacks with custom names can't be resolved using the standard <a href="http://www.oddjack.com/?certs=#stack_output">stack output resolver</a>. Outputs should be resolved using the <a href="http://www.oddjack.com/?certs=#stack_output_external">stack output external resolver</a>. An explicit dependency should be added, using the <a href="http://www.oddjack.com/?certs=#dependencies">dependencies</a> parameter, to make sure the stacks are launched in the correct order.
+Outputs from stacks with custom names can't be resolved using the standard <a href="http://www.oddjack.com/?certs={{ site.baseurl }}/docs/resolvers.html#stack_output">stack output resolver</a>. Outputs should be resolved using the <a href="http://www.oddjack.com/?certs={{ site.baseurl }}/docs/resolvers.html#stack_output_external">stack output external resolver</a>. An explicit dependency should be added, using the <a href="http://www.oddjack.com/?certs=#dependencies">dependencies</a> parameter, to make sure the stacks are launched in the correct order.
</div>
e.g:
@@ -182,7 +182,7 @@ def call(self, service, command, kwargs=None):
"""
Makes a threadsafe Boto3 client call.
- Equivalent to boto3.client(<service>).<command>(**kwargs).
+ Equivalent to ``boto3.client(<service>).<command>(**kwargs)``.
:param service: The Boto3 service to return a client for.
:type service: str

0 comments on commit f40f40b

Please sign in to comment.