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

Commit

Permalink
minor update to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ojkelly committed Jul 20, 2018
1 parent 32aff64 commit e876662
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
16 changes: 8 additions & 8 deletions documentation/content/guides/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ $ kombustion --load-plugin ../kombustion-plugin-example/kombustion-plugin-exampl
```


The easiest way to get started is to start from a copy of the [boilerplate](https://github.com/KablamoOSS/kombustion-plugin-boilerplate) example plugin. This repository has everything you need to get started writing a plugin, including default configuration, an example folder layout, and a build script.
The easiest way to get started is to start from a copy of the [boilerplate](https://github.com/KablamoOSS/kombustion-plugin-example) example plugin. This repository has everything you need to get started writing a plugin, including default configuration, an example folder layout, and a build script.

```bash
$ go get github.com/KablamoOSS/kombustion-plugin-boilerplate
$ cp $GOPATH/src/github.com/KablamoOSS/kombustion-plugin-boilerplate \
$ go get github.com/KablamoOSS/kombustion-plugin-example
$ cp $GOPATH/src/github.com/KablamoOSS/kombustion-plugin-example \
$GOPATH/src/github.com/{username}/{plugin}
```

Expand Down Expand Up @@ -87,9 +87,9 @@ func init() {
func Register() []byte {
return api.RegisterPlugin(types.Config{
// Name should match the name of your repository
// so github.com/KablamoOSS/kombustion-plugin-boilerplate
// becomes kombustion-plugin-boilerplate
Name: "kombustion-plugin-boilerplate",
// so github.com/KablamoOSS/kombustion-plugin-example
// becomes kombustion-plugin-example
Name: "kombustion-plugin-example",
// Version is set at compile time, to the tag
Version: version,
// The prefix for all resources this plugin exports
Expand Down Expand Up @@ -155,7 +155,7 @@ import (
"github.com/KablamoOSS/kombustion/pkg/plugins/api"
"github.com/KablamoOSS/kombustion/pkg/plugins/api/types"
// Import this plugins parser functions for resources
"github.com/KablamoOSS/kombustion-plugin-boilerplate/resources"
"github.com/KablamoOSS/kombustion-plugin-example/resources"
)
```

Expand Down Expand Up @@ -303,7 +303,7 @@ And example of how an error is printed:
✖ Error: Missing field 'CIDR'
☞ Resolution:
├─ Name: MyNetwork
├─ Plugin: kombustion-plugin-boilerplate
├─ Plugin: kombustion-plugin-example
└─ Type: Kablamo::Example::VPC
```

Expand Down
4 changes: 2 additions & 2 deletions documentation/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

<div id="main">
<div id="hero">
<div class="show-sm" style="text-align: center">
<img src="/img/favicons/logo.png" width="32" id="komby" />
<div style="text-align: center">
<img src="/img/favicons/logo.png" width="90" id="komby" />
</div>
<h1>{{.Title}}</h1>
<p>Extend CloudFormation with plugins</p>
Expand Down
2 changes: 1 addition & 1 deletion documentation/layouts/partials/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
</div>
<div class="hide-sm" id="top">
<div id="top-brand">
<img src="/img/favicons/logo.png" width="18" id="komby" />
<a href="/" title="home">{{ .Site.Title }}</a>
</div>
<nav id="top-nav-main">
Expand All @@ -27,5 +28,4 @@
</ul>
</nav>
<div id="dark-mode-toggle"></div>
<img src="/img/favicons/logo.png" width="32" id="komby" />
</div>

0 comments on commit e876662

Please sign in to comment.