Merge branch 'master' of https://github.com/kubextender/pvcexec

Author: ljufa

.gitignore

@@ -1,2 +1,3 @@
 dist/*
-.idea/
+.idea/
+*.log

docs/README.md

@@ -1,15 +1,14 @@
-# Getting started
+## Getting started
 
-* Navigate to [project's Github latest release](https://github.com/kubextender/pvcexec/releases/latest) and download the binary for your platform
-  * **Linux**: kubectl-pvcexec_x.y.z_linux_amd64
-  * **MacOS**: kubectl-pvcexec_x.y.z_darwin_amd64
-* Make the binary available on your `$PATH`, e.g `mv kubectl-pvcexec_x.y.z_linux_amd64 /usr/local/bin/`
+[filename](manual-install.md ':include')
 * List persistent volume claims: 
   ```bash
   # list PVCs to get the ones we're interested in
-  $ kubectl get pvc
-  # Run it!
-  $ kubectl pvcexec mc -p first.pvc.id -p second.pvc.id
+  kubectl get pvc
+  ```
+* Run it!
+  ```bash
+  kubectl pvcexec mc -p first.pvc.id -p second.pvc.id
   ```
 * This will by default open [midnight commander](https://midnight-commander.org/) showing given PVCs in left and right panel
 * Happy browsing! :blush:

docs/_coverpage.md

@@ -0,0 +1,11 @@
+<!-- _coverpage.md -->
+
+# pvcexec <small>0.1.4</small>
+
+> Missing kubernetes pvc manager!
+
+- Runs as a kubernetes plugin
+- Multiple commands (mc, zsh)
+
+[GitHub](https://github.com/kubextender/pvcexec/)
+[Getting Started](#getting-started)

docs/_navbar.md

@@ -1,4 +1,11 @@
 <!-- docs/_sidebar.md -->
+- Getting started
 
-* [Getting started](/)
-* [Docs](/docs.md)
+  - [Installing](how-to-install.md)
+    - [Manually](installing-plugin-manually.md)
+    - [Homebrew](installing-plugin-homebrew.md)
+  - [Running](running-quick-start.md)
+
+- Guide
+
+  - [Architecture](architecture.md)

docs/_sidebar.md

@@ -0,0 +1,3 @@
+# Architecture
+
+`pvcexec` is implemented as a kubernetes plugin. It's written in Go language

docs/architecture.md

@@ -0,0 +1,13 @@
+# How to install
+
+## Installing `pvcexec` manually
+
+?> We are actively working on providing `homebrew` install support and once we're done with it, manual 
+installation will be discontinued
+
+Read the section explaining [how to install](installing-plugin-manually.md) `pvcexec` manually
+
+## Installing `pvcexec` via homebrew
+
+Currently, this is not supported, but we're actively working on it!
+

docs/how-to-install.md

@@ -12,12 +12,11 @@
   <div id="app"></div>
   <script>
     window.$docsify = {
-      logo: '/_media/kubextender_logo.png',
-      name: 'kubextender',
+      name: 'pvcexec',
       repo: 'kubextender/pvcexec',
-      loadNavbar: true,
       themeColor: '#090240',
       loadSidebar: true,
+      coverpage: true,
       search: {
         noData: {
           '/': 'No results!'
@@ -32,5 +31,6 @@
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
   <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+  <script src="//unpkg.com/docsify-copy-code"></script>
 </body>
 </html>

docs/index.html

@@ -0,0 +1,3 @@
+# Installing plugin via homebrew
+
+Installing `pvcexec` via homebrew is not supported at the moment, but we're currently working on it!

docs/installing-plugin-homebrew.md

@@ -0,0 +1,5 @@
+# Installing `pvcexec` manually
+
+Installing `pvcexec` manually involves the following steps:
+
+[filename](manual-install.md ':include')