More mkdocs/Markdown tests.

This commit is contained in:
Johannes Findeisen 2022-11-12 19:31:11 +01:00
commit f76049709b
9 changed files with 61 additions and 76 deletions

View file

@ -1,5 +1,5 @@
--- ---
title: Configuration title: Overview
--- ---
# Configuration # Overview

View file

@ -4,10 +4,6 @@ title: Minimal Configuration Guide
# Minimal Configuration Guide # Minimal Configuration Guide
- <i>Added: 2013.09.30 by Johannes Findeisen (hanez)</i></li>
- <i>Last update: 2013.11.03 by Johannes Findeisen (hanez)</i></li>
- <i>License: <a href="http://creativecommons.org/licenses/by-sa/3.0/" class="ext">CC Attribution-Share Alike 3.0 Unported</a></i></li>
## Introduction ## Introduction
This is step-by-step guide on howto setup Linspector for monitoring two services on two hosts. Be sure This is step-by-step guide on howto setup Linspector for monitoring two services on two hosts. Be sure

View file

@ -0,0 +1,7 @@
---
title: Overview
---
# Overview
More to come...

View file

@ -2,25 +2,25 @@
title: FAQ title: FAQ
--- ---
<h2>FAQ</h2> # FAQ
<h3>General</h3> ## General
<h4>Is it posible to daemonize Linspector?</h4> ### Is it posible to daemonize Linspector?
<p>No. Linspector is an interactive software which provides a terminal based frontend called Lish for maintenance tasks. Daemonizing makes no sense. Maybe daemonizing will be added in the future. Just start Linspector in a <a href="https://www.gnu.org/software/screen/" class="ext">screen</a> or <a href="http://tmux.sourceforge.net/" class="ext">tmux</a> session and detach. This is how we are doing it.</p> <p>No. Linspector is an interactive software which provides a terminal based frontend called Lish for maintenance tasks. Daemonizing makes no sense. Maybe daemonizing will be added in the future. Just start Linspector in a <a href="https://www.gnu.org/software/screen/" class="ext">screen</a> or <a href="http://tmux.sourceforge.net/" class="ext">tmux</a> session and detach. This is how we are doing it.</p>
<h4>Will Linspector provide a RPC interface for management?</h4> ### Will Linspector provide a RPC interface for management?
<p>Yes. Linspector will provide a <a href="http://en.wikipedia.org/wiki/JSON-RPC" class="ext">JSON-RPC</a> based interface.</p> <p>Yes. Linspector will provide a <a href="http://en.wikipedia.org/wiki/JSON-RPC" class="ext">JSON-RPC</a> based interface.</p>
<h4>Is a web interface planned in Linspector?</h4> ### Is a web interface planned in Linspector?
<p>No. Linspector will not provide a web interface for management. BTW, there will be a seperate project called <a href="/projects/weblin/">WebLin</a> which provides a web interface for Linspector. WebLin will make use of the JSON-RPC interface provided by Linspector.</p> <p>No. Linspector will not provide a web interface for management. BTW, there will be a seperate project called <a href="/projects/weblin/">WebLin</a> which provides a web interface for Linspector. WebLin will make use of the JSON-RPC interface provided by Linspector.</p>
<h3>Errors</h3> ## Errors</h3>
<h4>I got "error: can't start new thread" in Lish. What happened?</h4> ### I got "error: can't start new thread" in Lish. What happened?
<p>The Error looks like this:</p> <p>The Error looks like this:</p>

View file

@ -5,15 +5,3 @@ title: Introduction
# Introduction # Introduction
More to come... More to come...
## Documentation and Guides
The following documentation is available to you:
- <a href="/faq/">The Linspector FAQ's</a>
- <a href="/installation-guide/">Installation Guide</a>
- <a href="/minimal-configuration-guide/">Minimal Configuration Guide</a>
If you want to try to understand how Linspector works you can take a look at the <a href="https://github.com/linspector/linspector/blob/master/examples/minimal.json" class="ext">minimal.json configuration file</a>. It really shows up what is currently possible with Linspector but is not documented. Please ask us if you want to know more.
More documentation will follow ASAP! It is a work in progress.

View file

@ -1,51 +1,7 @@
--- ---
title: Installation Guide title: Overview
--- ---
<h2>Installation Guide</h2> # Overview
<ul>
<li><i>Added: 2013.09.30 by Johannes Findeisen (hanez)</i></li>
<li><i>Last update: 2013.11.03 by Johannes Findeisen (hanez)</i></li>
<li><i>License: <a href="http://creativecommons.org/licenses/by-sa/3.0/" class="ext">CC Attribution-Share Alike 3.0 Unported</a></i></li>
</ul>
<h3>Introduction</h3>
<p>Here we show you how easy it is to install Linspector.</p> <p>Here we show you how easy it is to install Linspector.</p>
<h3>Get Linspector</h3>
<p>Go to the Linspector <a href="/download/">download page</a> and download the latest package as zip or tar.gz file and extract it.</p>
<p>Then switch to the new linspector directory:</p>
<pre>cd linspector-VERSION</pre>
<h3>Requirements</h3>
<p>You need at least Python 2.7.* and the APScheduler library to run Linspector. We recommend to install Python using your package manager. Libraries are very easy to install using the Python package manager pip. Just install pip from your systems package manager and run the following command:</p>
<pre>pip install apscheduler</pre>
<p>All dependencies are being resolved and everything needed will be installed.</p>
<p>To install all libraries Linspector is using - even the optionally libraries - you can do this by running the following command from the root of the Linspector source tree:</p>
<pre>pip install -r requirements.txt</pre>
<p>"requirements" is a text file provided by Linspector. When doing it this way you can be sure installing working versions of the libraries.</p>
<h3>Run Linspector</h3>
<p>Running Linspector is very easy. </p>
<p><b>Since Linspector currently is a little bit broken you need to set the $PYTHONPATH to make sure imports of libs are working:</b></p>
<pre>export PYTHONPATH=`pwd`</pre>
<p>Then you only need to run the following command:</p>
<pre>./bin/linspector path/to/config.json</pre>
<p>Since we have not created a config file yet you need to configure Linspector to really get it up running. Read the <a href="/documentation/minimal-configuration-guide/">Minimal Configuration Guide</a> for that.</p>

View file

@ -0,0 +1,41 @@
---
title: Installation Guide
---
# Installation Guide
## Get Linspector
<p>Go to the Linspector <a href="/download/">download page</a> and download the latest package as zip or tar.gz file and extract it.</p>
<p>Then switch to the new linspector directory:</p>
<pre>cd linspector-VERSION</pre>
## Requirements
<p>You need at least Python 2.7.* and the APScheduler library to run Linspector. We recommend to install Python using your package manager. Libraries are very easy to install using the Python package manager pip. Just install pip from your systems package manager and run the following command:</p>
<pre>pip install apscheduler</pre>
<p>All dependencies are being resolved and everything needed will be installed.</p>
<p>To install all libraries Linspector is using - even the optionally libraries - you can do this by running the following command from the root of the Linspector source tree:</p>
<pre>pip install -r requirements.txt</pre>
<p>"requirements" is a text file provided by Linspector. When doing it this way you can be sure installing working versions of the libraries.</p>
## Run Linspector
<p>Running Linspector is very easy. </p>
<p><b>Since Linspector currently is a little bit broken you need to set the $PYTHONPATH to make sure imports of libs are working:</b></p>
<pre>export PYTHONPATH=`pwd`</pre>
<p>Then you only need to run the following command:</p>
<pre>./bin/linspector path/to/config.json</pre>
<p>Since we have not created a config file yet you need to configure Linspector to really get it up running. Read the <a href="/documentation/minimal-configuration-guide/">Minimal Configuration Guide</a> for that.</p>

View file

@ -1,6 +1,7 @@
site_name: Linspector site_name: Linspector
repo_url: https://git.unixpeople.org/linspector/docs.linspector.org/
dev_addr: '127.0.0.1:4000'
# mkdocs, readthedocs, material, cerulean, cosmo, cyborg, darkly, flatly, journal, litera, lumen, lux, materia, minty, pulse, sandstone, simplex, slate, solar, spacelab, superhero, united, yeti
theme: theme:
name: readthedocs name: readthedocs
custom_dir: overrides custom_dir: overrides

View file

@ -1,5 +1 @@
mkdocs~=1.4.2 mkdocs~=1.4.2
mkdocs-bootstrap~=1.1
mkdocs-bootswatch~=1.1
mkdocs-rtd-dropdown~=1.0.2
mkdocs-rtd-mklab~=1.8.0