Skip to content

Commit

Permalink
add sources for the docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
omissis committed Feb 11, 2020
1 parent 5b62a9d commit f8623e2
Show file tree
Hide file tree
Showing 12 changed files with 127 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/archetypes/blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = ""
description = ""
date = {{ .Date }}
weight = 20
draft = false
+++
6 changes: 6 additions & 0 deletions docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

9 changes: 9 additions & 0 deletions docs/archetypes/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = ""
description = ""
date = {{ .Date }}
weight = 20
draft = false
bref = ""
toc = true
+++
9 changes: 9 additions & 0 deletions docs/config/_default/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
languageCode = "en-us"
title = "kube-profefe"
publishDir = "../../docs"
theme = ["kube-profefe", "kube"]
ignoreFiles = [ "src/" ]

[params]
claim = "Kubernetes continuous profiling made easy"
twitter = "https://twitter.com/gianarb"
1 change: 1 addition & 0 deletions docs/config/development/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
baseURL = ""
1 change: 1 addition & 0 deletions docs/config/production/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
baseURL = "/kube-profefe/"
62 changes: 62 additions & 0 deletions docs/themes/kube-profefe/layouts/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{{ define "title"}} {{ .Site.Title}} {{end}}
{{ define "header"}} {{ partial "header" .}} {{end}}
{{ define "main"}}

<div id="main">
<div id="hero">
<h1>{{.Site.Params.claim}}</h1>
<p>{{.Description}}</p>
</div>
<div id="action-buttons">
<a class="button primary big" href="https://github.com/profefe/kube-profefe/releases" onclick="_gaq.push(['_trackEvent', 'kube', 'download']);">Download</a>
<a class="button outline big" href="https://github.com/profefe/kube-profefe" onclick="_gaq.push(['_trackEvent', 'kube', 'github']);">View on Github</a>
<p>Docker images, batteries included.</p>
</div>
<div class="message focus" data-component="message"> <span class="close small"></span>
<a class="small " href="https://github.com/profefe/profefe">Profefe</a> from <a href="https://github.com/narqo">narqo</a> is an awesome <mark>Profiling tool for Go applications</mark>. <a class="small " href="https://github.com/profefe/kube-profefe">Kube-profefe</a> brings all the goodness to your own k8s cluster !
</div>
<div id="kube-features">
<div class="row gutters">
<div class="col col-4 item">
<figure>
<img alt="Cloud" height="48" src="{{ "/img/icon-cloud.svg" | relURL }}" width="48">
</figure>
<h3>Kubernetes friendly</h3>
<p>Thanks to <strong>kprofefe</strong>, you can consistently gather your profiling data and send it to profefe api server.</p>
</div>
<div class="col col-4 item">
<figure>
<img alt="Terminal" height="48" src="{{ "/img/icon-terminal.svg" | relURL }}" width="48">
</figure>
<h3>Command-line powered</h3>
<p>Kube-profefe provides <strong>kubectl-profefe</strong>, a <strong>kubectl</strong> plugin that helps you fetch and store pprof profiles.</p>
</div>
<div class="col col-4 item">
<figure>
<img alt="Markup" height="48" src="{{ "/img/icon-markup.svg" | relURL }}" width="48">
</figure>
<h3>Annotation strong</h3>
<p>Quickly and easily configure your containers thanks to powerful and convenient annotations.</p>
</div>
</div>
<div class="row gutters">
<div class="col col-4 item">
<h4>Continuous profiling. In your cluster.</h4>
<p>Keep your applications' performances under control easily and conveniently thanks to this tool.</p>
</div>
<div class="col col-4 item">
<h4>Ease of use</h4>
<p>kube-profefe integrates with kubectl and k8s's Scheduled Jobs. Putting it to work is as easy as writing some annotations.</p>
</div>
<div class="col col-4 item">
<h4>License</h4>
<p>
Kube-profefe is licensed under <a href="https://opensource.org/licenses/MIT">MIT</a>.<br>
Kube-profefe is absolutely free for personal or commercial use.
</p>
</div>
</div>
</div>
</div>
{{ end }}
{{ define "footer"}} {{ partial "footer" .}} {{end}}
17 changes: 17 additions & 0 deletions docs/themes/kube-profefe/layouts/partials/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<footer id="footer">
<nav>
<ul>
<li><span>Kube-profefe</span></li>
<li>
<a href="/about/">About</a>
</li>
<li>
<a href="https://github.com/profefe/kube-profefe">GitHub</a>
</li>
<li>
<a href="https://twitter.com/{{.Site.Params.twitter}}">Twitter</a>
</li>
</ul>
</nav>
<p>&copy; Licence MIT.</p>
</footer>
1 change: 1 addition & 0 deletions docs/themes/kube-profefe/static/img/icon-cloud.svg
Loading
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 docs/themes/kube-profefe/static/img/icon-markup.svg
Loading
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 docs/themes/kube-profefe/static/img/icon-terminal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/themes/kube-profefe/theme.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name = "Kube-profefe"
license = "MIT"
licenselink = "https://github.com/profefe/kube-profefe/blob/master/LICENSE"
description = "A Hugo theme for kube-profefe"
homepage = "https://kube.profefe.com"
tags = ["documentation", "multilingual", "customizable", "responsive", "docs"]
features = []
min_version = 0.63

[author]
name = "The Kube-profefe Authors"
homepage = "https://kube.profefe.com"

0 comments on commit f8623e2

Please sign in to comment.