scaffold the docs and faq structure

profefe · Feb 12, 2020 · 3a135e7 · 3a135e7
1 parent 5e0958a
commit 3a135e7
Show file tree

Hide file tree

Showing 8 changed files with 391 additions and 2 deletions.
diff --git a/docs/config/_default/config.toml b/docs/config/_default/config.toml
@@ -2,8 +2,22 @@ languageCode = "en-us"
 title = "kube-profefe"
 publishDir = "../public"
 theme = ["kube-profefe", "kube"]
-ignoreFiles = [ "src/" ]
+ignoreFiles = []
 
-[params]
+Paginate = 4
+[Params]
+  RSSLink = "/index.xml"
+  author = "gianarb"
   claim = "Kubernetes continuous profiling made easy"
+  github = "https://github.com/profefe/kube-profefe"
   twitter = "https://twitter.com/gianarb"
+  email = ""
+
+[[menu.main]]
+    name = "Docs"
+    weight = -100
+    url = "/docs/"
+[[menu.main]]
+    name = "Faq"
+    weight = -100
+    url = "/faq/"
diff --git a/docs/content/_index.md b/docs/content/_index.md
@@ -0,0 +1,6 @@
++++
+description = "Kube-profefe is a project that acts as a bridge between profefe and Kubernetes that offers a kubectl plugin and a cron-able executable that regularly sends profiling data to profefe."
+title = "Kube-profefe"
+draft = false
+
++++
diff --git a/docs/content/about.md b/docs/content/about.md
@@ -0,0 +1,20 @@
++++
+title = "Sign In"
++++
+<form action="" data-component="validate" method="post" class="form form-centered"><input type="hidden" name="authorize-token" value="">
+
+    <div class="form-item">
+        <label>Email <span id="user-email-validation-error"></span></label>
+        <input type="email" name="user-email" autofocus="true" autocomplete="off" style="background-image: url(&quot;data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAASCAYAAABSO15qAAAAAXNSR0IArs4c6QAAAPhJREFUOBHlU70KgzAQPlMhEvoQTg6OPoOjT+JWOnRqkUKHgqWP4OQbOPokTk6OTkVULNSLVc62oJmbIdzd95NcuGjX2/3YVI/Ts+t0WLE2ut5xsQ0O+90F6UxFjAI8qNcEGONia08e6MNONYwCS7EQAizLmtGUDEzTBNd1fxsYhjEBnHPQNG3KKTYV34F8ec/zwHEciOMYyrIE3/ehKAqIoggo9inGXKmFXwbyBkmSQJqmUNe15IRhCG3byphitm1/eUzDM4qR0TTNjEixGdAnSi3keS5vSk2UDKqqgizLqB4YzvassiKhGtZ/jDMtLOnHz7TE+yf8BaDZXA509yeBAAAAAElFTkSuQmCC&quot;); background-repeat: no-repeat; background-attachment: scroll; background-size: 16px 18px; background-position: 98% 50%; cursor: auto;">
+    </div>
+
+    <div class="form-item">
+        <label>Password <span id="user-password-validation-error"></span></label>
+        <input type="password" name="user-password" autocomplete="off" style="background-image: url(&quot;data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAASCAYAAABSO15qAAAAAXNSR0IArs4c6QAAAPhJREFUOBHlU70KgzAQPlMhEvoQTg6OPoOjT+JWOnRqkUKHgqWP4OQbOPokTk6OTkVULNSLVc62oJmbIdzd95NcuGjX2/3YVI/Ts+t0WLE2ut5xsQ0O+90F6UxFjAI8qNcEGONia08e6MNONYwCS7EQAizLmtGUDEzTBNd1fxsYhjEBnHPQNG3KKTYV34F8ec/zwHEciOMYyrIE3/ehKAqIoggo9inGXKmFXwbyBkmSQJqmUNe15IRhCG3byphitm1/eUzDM4qR0TTNjEixGdAnSi3keS5vSk2UDKqqgizLqB4YzvassiKhGtZ/jDMtLOnHz7TE+yf8BaDZXA509yeBAAAAAElFTkSuQmCC&quot;); background-repeat: no-repeat; background-attachment: scroll; background-size: 16px 18px; background-position: 98% 50%; cursor: auto;">
+    </div>
+
+    <p><button class="button primary width-100">Log in</button></p>
+    <p><a href="/password-recovery/" class="small muted">Forgot password?</a></p>
+    <p class="small">If you have any questions about authorization or you're our customer but haven't receive your login credentials, just send us a short email at <b>[email protected]</b> and we'll fix it right away.</p>
+
+</form>
diff --git a/docs/content/docs/developing.md b/docs/content/docs/developing.md
@@ -0,0 +1,81 @@
++++
+title = "Developing"
+description = "Contributing to kube-profefe"
+weight = 30
+draft = false
+toc = true
+bref = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur neque risus, maximus malesuada massa eget, auctor vulputate ipsum. Suspendisse magna libero, iaculis non ante nec, laoreet faucibus ligula. Suspendisse sed enim urna. Quisque libero dui, porttitor eu diam quis, elementum mattis nunc."
++++
+
+<h3 class="section-head" id="h-basic-template"><a href="#h-basic-template">Basic Template</a></h3>
+
+<p>With Kube, you can set up your web framework and be on your way in under a minute. Just add this code to your web page for the basic template to take effect immediately.</p>
+
+<pre class="code"><span class="hljs-meta">&lt;!DOCTYPE html&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">html</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">head</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">title</span>&gt;</span>Basic Template<span class="hljs-tag">&lt;/<span class="hljs-name">title</span>&gt;</span>
+
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">charset</span>=<span class="hljs-string">"utf-8"</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"viewport"</span> <span class="hljs-attr">content</span>=<span class="hljs-string">"width=device-width, initial-scale=1"</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube CSS --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"assets/css/kube.css"</span>&gt;</span>
+
+<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">h1</span>&gt;</span>Hello, world!<span class="hljs-tag">&lt;/<span class="hljs-name">h1</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube JS + jQuery are used for some functionality, but are not required for the basic setup --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"assets/js/kube.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span></pre>
+
+
+<h3 class="section-head" id="h-supported-browsers"><a href="#h-supported-browsers">Supported Browsers</a></h3>
+
+<p>Kube supports the latest, stable releases of all major browsers:</p>
+<ul>
+    <li>Latest Chrome</li>
+    <li>Latest Firefox</li>
+    <li>Latest Safari</li>
+    <li>Latest Opera</li>
+    <li>Microsoft Edge</li>
+    <li>Internet Explorer 11</li>
+</ul>
+
+
+<h3 class="section-head" id="h-development"><a href="#h-development">Development with Kube</a></h3>
+
+<p>Kube has been designed to help you with web development, that's why it's so easy to use Kube when building websites. To move forward quickly and efficiently, just link <code>kube.scss</code> from Kube package: this file contains variables, mixins and everything you need to simplify daily routine tasks.
+</p>
+
+<p>
+    For example, import kube.scss into your master.scss styles file, which you will later compile into <code>master.css</code>:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;</pre>
+
+<p>
+    Now all Kube's variables and mixins are readily available in <code>master.scss</code>,
+    and you can use them whenever needed. For instance, here's how one of examples:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+<span class="hljs-keyword">@import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#sidebar</span> {
+    <span class="hljs-variable">@include</span> flex-item-width(<span class="hljs-number">200px</span>);
+}</pre>
+
+<p>Also, you could use settings from <code>variables.scss</code>:</p>
+
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#my-layout</span> {
+    <span class="hljs-attribute">padding</span>: <span class="hljs-variable">$base-line</span>;
+}</pre>
diff --git a/docs/content/docs/examples.md b/docs/content/docs/examples.md
@@ -0,0 +1,81 @@
++++
+title = "Examples"
+description = "How to use kube-profefe in real life"
+weight = 40
+draft = false
+toc = true
+bref = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur neque risus, maximus malesuada massa eget, auctor vulputate ipsum. Suspendisse magna libero, iaculis non ante nec, laoreet faucibus ligula. Suspendisse sed enim urna. Quisque libero dui, porttitor eu diam quis, elementum mattis nunc."
++++
+
+<h3 class="section-head" id="h-basic-template"><a href="#h-basic-template">Basic Template</a></h3>
+
+<p>With Kube, you can set up your web framework and be on your way in under a minute. Just add this code to your web page for the basic template to take effect immediately.</p>
+
+<pre class="code"><span class="hljs-meta">&lt;!DOCTYPE html&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">html</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">head</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">title</span>&gt;</span>Basic Template<span class="hljs-tag">&lt;/<span class="hljs-name">title</span>&gt;</span>
+
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">charset</span>=<span class="hljs-string">"utf-8"</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"viewport"</span> <span class="hljs-attr">content</span>=<span class="hljs-string">"width=device-width, initial-scale=1"</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube CSS --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"assets/css/kube.css"</span>&gt;</span>
+
+<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">h1</span>&gt;</span>Hello, world!<span class="hljs-tag">&lt;/<span class="hljs-name">h1</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube JS + jQuery are used for some functionality, but are not required for the basic setup --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"assets/js/kube.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span></pre>
+
+
+<h3 class="section-head" id="h-supported-browsers"><a href="#h-supported-browsers">Supported Browsers</a></h3>
+
+<p>Kube supports the latest, stable releases of all major browsers:</p>
+<ul>
+    <li>Latest Chrome</li>
+    <li>Latest Firefox</li>
+    <li>Latest Safari</li>
+    <li>Latest Opera</li>
+    <li>Microsoft Edge</li>
+    <li>Internet Explorer 11</li>
+</ul>
+
+
+<h3 class="section-head" id="h-development"><a href="#h-development">Development with Kube</a></h3>
+
+<p>Kube has been designed to help you with web development, that's why it's so easy to use Kube when building websites. To move forward quickly and efficiently, just link <code>kube.scss</code> from Kube package: this file contains variables, mixins and everything you need to simplify daily routine tasks.
+</p>
+
+<p>
+    For example, import kube.scss into your master.scss styles file, which you will later compile into <code>master.css</code>:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;</pre>
+
+<p>
+    Now all Kube's variables and mixins are readily available in <code>master.scss</code>,
+    and you can use them whenever needed. For instance, here's how one of examples:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+<span class="hljs-keyword">@import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#sidebar</span> {
+    <span class="hljs-variable">@include</span> flex-item-width(<span class="hljs-number">200px</span>);
+}</pre>
+
+<p>Also, you could use settings from <code>variables.scss</code>:</p>
+
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#my-layout</span> {
+    <span class="hljs-attribute">padding</span>: <span class="hljs-variable">$base-line</span>;
+}</pre>
diff --git a/docs/content/docs/installation.md b/docs/content/docs/installation.md
@@ -0,0 +1,81 @@
++++
+title = "Installation"
+description = "Setting up the tools"
+weight = 20
+draft = false
+toc = true
+bref = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur neque risus, maximus malesuada massa eget, auctor vulputate ipsum. Suspendisse magna libero, iaculis non ante nec, laoreet faucibus ligula. Suspendisse sed enim urna. Quisque libero dui, porttitor eu diam quis, elementum mattis nunc."
++++
+
+<h3 class="section-head" id="h-basic-template"><a href="#h-basic-template">Basic Template</a></h3>
+
+<p>With Kube, you can set up your web framework and be on your way in under a minute. Just add this code to your web page for the basic template to take effect immediately.</p>
+
+<pre class="code"><span class="hljs-meta">&lt;!DOCTYPE html&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">html</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">head</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">title</span>&gt;</span>Basic Template<span class="hljs-tag">&lt;/<span class="hljs-name">title</span>&gt;</span>
+
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">charset</span>=<span class="hljs-string">"utf-8"</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"viewport"</span> <span class="hljs-attr">content</span>=<span class="hljs-string">"width=device-width, initial-scale=1"</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube CSS --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"assets/css/kube.css"</span>&gt;</span>
+
+<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">h1</span>&gt;</span>Hello, world!<span class="hljs-tag">&lt;/<span class="hljs-name">h1</span>&gt;</span>
+
+    <span class="hljs-comment">&lt;!-- Kube JS + jQuery are used for some functionality, but are not required for the basic setup --&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+    <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"assets/js/kube.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
+<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span></pre>
+
+
+<h3 class="section-head" id="h-supported-browsers"><a href="#h-supported-browsers">Supported Browsers</a></h3>
+
+<p>Kube supports the latest, stable releases of all major browsers:</p>
+<ul>
+    <li>Latest Chrome</li>
+    <li>Latest Firefox</li>
+    <li>Latest Safari</li>
+    <li>Latest Opera</li>
+    <li>Microsoft Edge</li>
+    <li>Internet Explorer 11</li>
+</ul>
+
+
+<h3 class="section-head" id="h-development"><a href="#h-development">Development with Kube</a></h3>
+
+<p>Kube has been designed to help you with web development, that's why it's so easy to use Kube when building websites. To move forward quickly and efficiently, just link <code>kube.scss</code> from Kube package: this file contains variables, mixins and everything you need to simplify daily routine tasks.
+</p>
+
+<p>
+    For example, import kube.scss into your master.scss styles file, which you will later compile into <code>master.css</code>:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;</pre>
+
+<p>
+    Now all Kube's variables and mixins are readily available in <code>master.scss</code>,
+    and you can use them whenever needed. For instance, here's how one of examples:
+</p>
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+<span class="hljs-keyword">@import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#sidebar</span> {
+    <span class="hljs-variable">@include</span> flex-item-width(<span class="hljs-number">200px</span>);
+}</pre>
+
+<p>Also, you could use settings from <code>variables.scss</code>:</p>
+
+
+<pre class="code"><span class="hljs-comment">// master.scss</span>
+@<span class="hljs-keyword">import</span> <span class="hljs-string">"dist/scss/kube.scss"</span>;
+
+<span class="hljs-selector-id">#my-layout</span> {
+    <span class="hljs-attribute">padding</span>: <span class="hljs-variable">$base-line</span>;
+}</pre>