Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.

Commit

Permalink
stubbing out some more pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ojkelly committed Jun 26, 2018
1 parent 834f7de commit 6684965
Show file tree
Hide file tree
Showing 15 changed files with 100 additions and 17 deletions.
1 change: 1 addition & 0 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules/**
public/**
29 changes: 29 additions & 0 deletions documentation/content/api/manifest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
+++
title = "kombustion.yaml"
description = ""
date = "2018-06-14T00:00:00+10:00"
weight = 20
draft = false
bref = ""
toc = true
layout = "docs"
+++



```yaml
name: Test
region: ap-southeast-2
plugins:
github.com/KablamoOSS/kombustion-plugin-serverless@0.1.0:
name: github.com/KablamoOSS/kombustion-plugin-serverless
version: 0.1.0
alias: ""
environments:
production:
accountIDs:
- "13521354"
parameters:
ENVIRONMENT: production
hideDefaultExports: false
```
33 changes: 30 additions & 3 deletions documentation/content/concepts/manifest.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
+++
title = "Manifest"
description = "kombustion.yaml"
title = "kombustion.yaml"
description = "The manifest file contains information about a projects plugins, and parameters."
date = "2018-06-14T00:00:00+10:00"
weight = 20
draft = false
bref = ""
bref = "The manifest file contains information about a projects plugins, and parameters."
toc = true
layout = "docs"
+++


## Example


```yaml
name: Test
region: ap-southeast-2
plugins:
github.com/KablamoOSS/kombustion-plugin-serverless@0.1.0:
name: github.com/KablamoOSS/kombustion-plugin-serverless
version: 0.1.0
alias: ""
environments:
production:
accountIDs:
- "13521354"
parameters:
ENVIRONMENT: production
hideDefaultExports: false
```

## How to use


## Example Project
8 changes: 4 additions & 4 deletions documentation/content/guides/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ func Register() []byte {
// Name should match the name of your repository
// so github.com/KablamoOSS/kombustion-plugin-boilerplate
// becomes kombustion-plugin-boilerplate
Name: "kombustion-plugin-boilerplate",
Name: "kombustion-plugin-boilerplate",
// Version is set at compile time, to the tag
Version: version,
Version: version,
// The prefix for all resources this plugin exports
Prefix: "Kablamo::Boilerplate",
Prefix: "Kablamo::Boilerplate",
Help: types.Help{
Description: "An Example Plugin",
TypeMappings: []types.TypeMapping{
Expand Down Expand Up @@ -321,7 +321,7 @@ these match it sould just work.

For release, you need to ensure you have a build for every operating system and architecture `kombustion` supports.

We use a tool called `xgo` which uses Docker to compile for all possible versions, using the correct C compiler.
We use a tool called [`xgo`](github.com/karalabe/xgo) which uses Docker to compile for all possible versions, using the correct C compiler.

The following is a working `.travis.yml` configuration that will compile and attach a release to your Github repository.

Expand Down
8 changes: 4 additions & 4 deletions documentation/layouts/_default/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
{{ define "main" }}

<div id="hero" class="wrap">
<h1>{{.Site.Params.author }}</h1>
<h1>{{.Title }}</h1>
</div>
<ul id="posts">

{{ range .Paginator.Pages.ByWeight }} {{ partial "page-summary" . }} {{ end }}
<section>{{ partial "pagination" .}}</section>
</ul>

{{ end }}
{{ define "footer" }}
{{ partial "footer" . }}
{{ end }}
{{ define "footer" }}
{{ partial "footer" . }}
{{ end }}
10 changes: 5 additions & 5 deletions documentation/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ <h1>{{.Title}}</h1>
<div class="row gutters">
<div class="col col-4 item">
<figure>
<img alt="Baseline" height="48" src="{{ "/img/kube/icon-baseline.png" | relURL }}" width="48">
<img alt="Baseline" height="48" src="{{ "/img/pictogram/47- cloud-laptop-programming-upload.svg" | relURL }}" width="96" class="pictogram">
</figure>
<h3>Write Native Cloudformation</h3>
<p></p>
<p>Kombustion builds upon native Cloudformation, so you don't need to learn a new syntax or DSL.</p>
</div>
<div class="col col-4 item">
<figure>
<img alt="Typography" height="48" src="{{ "/img/kube/icon-typo.png" | relURL }}" width="48">
<img alt="Typography" height="48" src="{{ "/img/pictogram/22- jigsaw-programming-drag-and-drop-2.svg" | relURL }}" width="96" class="pictogram">
</figure>
<h3>Extend with Plugins</h3>
<p>Kombustion uses plugins to preprocess and extend your CloudFormation templates.</p>
</div>
<div class="col col-4 item">
<figure>
<img alt="Minimalism" height="48" src="{{ "/img/kube/icon-minimalism.png" | relURL }}" width="48">
<img alt="Minimalism" height="48" src="{{ "/img/pictogram/17- flowchart.svg" | relURL }}" width="96" class="pictogram">
</figure>
<h3>Clean up your IaaC</h3>
<p>We strongly believe in minimalism as a general concept as well as a practical approach to everyday life.</p>
Expand All @@ -41,7 +41,7 @@ <h3>Clean up your IaaC</h3>
<div class="row gutters">
<div class="col col-4 item">
<h4>Decentralised Plugins</h4>
<p>Kombustion plugins can be installed from a plugins Github repository</p>
<p>Kombustion plugins can be installed from a plugins Github repository.</p>
</div>
<div class="col col-4 item">
<h4>Cross-Platform</h4>
Expand Down
12 changes: 12 additions & 0 deletions documentation/static-src/_scss/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#hero h1 {
text-decoration: none;
font-family: $logo-font-family;
text-transform: uppercase;
color: black;
font-style: italic;
font-weight: 900;
}


img.pictogram {
}
1 change: 1 addition & 0 deletions documentation/static-src/kube.scss
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
@import "_scss/components";

@import "_scss/custom/master";
@import "_scss/custom/custom";
@import "_scss/custom/documentation";
@import "_scss/custom/font";
@import "_scss/custom/header";
8 changes: 8 additions & 0 deletions documentation/static/css/kube.css
Original file line number Diff line number Diff line change
Expand Up @@ -3612,6 +3612,14 @@ tr.border-none td {
margin-top: 24px;
top: 0; } }

#hero h1 {
text-decoration: none;
font-family: "Passion One", sans-serif;
text-transform: uppercase;
color: black;
font-style: italic;
font-weight: 900; }

body.dark {
background-color: #222 !important; }

Expand Down
2 changes: 1 addition & 1 deletion documentation/static/css/kube.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions documentation/static/img/bg.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions documentation/static/img/pictogram/17- flowchart.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6684965

Please sign in to comment.