From f76049709bfb20b42e0531e3c67e3f25ffd727bc Mon Sep 17 00:00:00 2001 From: Johannes Findeisen Date: Sat, 12 Nov 2022 19:31:11 +0100 Subject: [PATCH] More mkdocs/Markdown tests. --- docs/configuration/index.md | 4 +- docs/configuration/minimal-configuration.md | 4 -- docs/development/index.md | 7 +++ docs/faq.md | 14 +++--- docs/index.md | 12 ------ docs/installation/index.md | 48 +-------------------- docs/installation/installtion-guide.md | 41 ++++++++++++++++++ mkdocs.yml | 3 +- requirements.txt | 4 -- 9 files changed, 61 insertions(+), 76 deletions(-) create mode 100644 docs/development/index.md create mode 100644 docs/installation/installtion-guide.md diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 4083682..3e2a4fb 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -1,5 +1,5 @@ --- -title: Configuration +title: Overview --- -# Configuration +# Overview diff --git a/docs/configuration/minimal-configuration.md b/docs/configuration/minimal-configuration.md index 5c8362b..60defac 100644 --- a/docs/configuration/minimal-configuration.md +++ b/docs/configuration/minimal-configuration.md @@ -4,10 +4,6 @@ title: Minimal Configuration Guide # Minimal Configuration Guide - - Added: 2013.09.30 by Johannes Findeisen (hanez) - - Last update: 2013.11.03 by Johannes Findeisen (hanez) - - License: CC Attribution-Share Alike 3.0 Unported - ## Introduction This is step-by-step guide on howto setup Linspector for monitoring two services on two hosts. Be sure diff --git a/docs/development/index.md b/docs/development/index.md new file mode 100644 index 0000000..ad6bba9 --- /dev/null +++ b/docs/development/index.md @@ -0,0 +1,7 @@ +--- +title: Overview +--- + +# Overview + +More to come... diff --git a/docs/faq.md b/docs/faq.md index 1c1390f..2a412dc 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,25 +2,25 @@ title: FAQ --- -

FAQ

+# FAQ -

General

+## General -

Is it posible to daemonize Linspector?

+### Is it posible to daemonize Linspector?

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 screen or tmux session and detach. This is how we are doing it.

-

Will Linspector provide a RPC interface for management?

+### Will Linspector provide a RPC interface for management?

Yes. Linspector will provide a JSON-RPC based interface.

-

Is a web interface planned in Linspector?

+### Is a web interface planned in Linspector?

No. Linspector will not provide a web interface for management. BTW, there will be a seperate project called WebLin which provides a web interface for Linspector. WebLin will make use of the JSON-RPC interface provided by Linspector.

-

Errors

+## Errors -

I got "error: can't start new thread" in Lish. What happened?

+### I got "error: can't start new thread" in Lish. What happened?

The Error looks like this:

diff --git a/docs/index.md b/docs/index.md index a60533e..ec9e14f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,15 +5,3 @@ title: Introduction # Introduction More to come... - -## Documentation and Guides - -The following documentation is available to you: - -- The Linspector FAQ's -- Installation Guide -- Minimal Configuration Guide - -If you want to try to understand how Linspector works you can take a look at the minimal.json configuration file. 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. diff --git a/docs/installation/index.md b/docs/installation/index.md index ff808da..c26cc7f 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -1,51 +1,7 @@ --- -title: Installation Guide +title: Overview --- -

Installation Guide

- - - -

Introduction

+# Overview

Here we show you how easy it is to install Linspector.

- -

Get Linspector

- -

Go to the Linspector download page and download the latest package as zip or tar.gz file and extract it.

- -

Then switch to the new linspector directory:

- -
cd linspector-VERSION
- -

Requirements

- -

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:

- -
pip install apscheduler
- -

All dependencies are being resolved and everything needed will be installed.

- -

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:

- -
pip install -r requirements.txt
- -

"requirements" is a text file provided by Linspector. When doing it this way you can be sure installing working versions of the libraries.

- -

Run Linspector

- -

Running Linspector is very easy.

- -

Since Linspector currently is a little bit broken you need to set the $PYTHONPATH to make sure imports of libs are working:

- -
export PYTHONPATH=`pwd`
- -

Then you only need to run the following command:

- -
./bin/linspector path/to/config.json
- -

Since we have not created a config file yet you need to configure Linspector to really get it up running. Read the Minimal Configuration Guide for that.

diff --git a/docs/installation/installtion-guide.md b/docs/installation/installtion-guide.md new file mode 100644 index 0000000..4ff1c0f --- /dev/null +++ b/docs/installation/installtion-guide.md @@ -0,0 +1,41 @@ +--- +title: Installation Guide +--- + +# Installation Guide + +## Get Linspector + +

Go to the Linspector download page and download the latest package as zip or tar.gz file and extract it.

+ +

Then switch to the new linspector directory:

+ +
cd linspector-VERSION
+ +## Requirements + +

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:

+ +
pip install apscheduler
+ +

All dependencies are being resolved and everything needed will be installed.

+ +

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:

+ +
pip install -r requirements.txt
+ +

"requirements" is a text file provided by Linspector. When doing it this way you can be sure installing working versions of the libraries.

+ +## Run Linspector + +

Running Linspector is very easy.

+ +

Since Linspector currently is a little bit broken you need to set the $PYTHONPATH to make sure imports of libs are working:

+ +
export PYTHONPATH=`pwd`
+ +

Then you only need to run the following command:

+ +
./bin/linspector path/to/config.json
+ +

Since we have not created a config file yet you need to configure Linspector to really get it up running. Read the Minimal Configuration Guide for that.

diff --git a/mkdocs.yml b/mkdocs.yml index 05e90a4..363cb5e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,7 @@ 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: name: readthedocs custom_dir: overrides diff --git a/requirements.txt b/requirements.txt index bf6e457..1df5523 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1 @@ mkdocs~=1.4.2 -mkdocs-bootstrap~=1.1 -mkdocs-bootswatch~=1.1 -mkdocs-rtd-dropdown~=1.0.2 -mkdocs-rtd-mklab~=1.8.0 \ No newline at end of file