Git Product home page Git Product logo

naemon.github.io's Introduction

naemon.github.io

The naemon website.

Written for Jekyll, and relying on bootstrap.

Install locally

Read the online guide from github at: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

Run locally using Docker

First build the Docker image which will contain Ruby, Jekyll and all the required dependencies

docker build . -t naemon/docs

Now run the Docker container and navigate to http://127.0.0.1:4000 in your browser. The container watches for file changes and will automatically regenerate the website if needed.

docker run --rm -it -v "$PWD":/site -p "4000:4000" naemon/docs:latest

naemon.github.io's People

Contributors

ageric avatar asabatep avatar awiddersheim avatar benjamin-bergia avatar catharsis avatar ceh avatar fmikker avatar herkum avatar insanity54 avatar jacobbaungard avatar jryberg avatar julianbrost avatar kjetilho avatar lingej avatar midek avatar nook24 avatar ozamosi avatar petemorgan avatar pjaoggaspar avatar rezib avatar roelvanmeer avatar sjoegren avatar sni avatar tvestelind avatar wasserman avatar weirdbricks avatar ymattw avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

naemon.github.io's Issues

Formatting Issues with (|) symbol

the md format gets confused when using the | (the pipe character) in certain situations. I have a branch request.

If it sees a pipe character and it is not included in text that associated with a paragraph, it assumes that it is a table and the pipe marks the end of the cell.

Problems installing on Debian

I am running debian 8.x so I went to the quickstart-debian page. Part of the instructions is to use wget to retrieve a bunch of files, then use dpkg -i naemon*.deb to install them. The problem here is that you have a package named libnaemon, that isn't in the list of things to download with curl, and wouldn't be matched by the wildcard pattern used with dpkg. If you follow these steps the install fails, because it is missing libnaemon. The documentation should be updated.

Ref:

As an alternative, you could post a set of directions similar to this in the quickstart, that would let people download the packages, and then add a local apt repo. Using the wget in recursive mode would
automatically get all the packages in the directory. Also you wouldn't need to have to instruct the users to manually pre-install the dependencies.

# update this to be the base URL for your release/arch
releaseurl='https://labs.consol.de/naemon/release/v1.0.3/debian8/amd64/'
# update this to be a local path where you want to cache the packages
packagedir='/usr/src/naemon/'
# make folder to cache packages
mkdir -p ${packagedir}
cd ${packagedir}
# download the packages
wget --recursive --timestamping \
     --no-parent --cut-dirs=2 --no-host-directories \
     $releaseurl
# build an packages file for apt
cd ${packagedir}v1.0.3/
dpkg-scanpackages . /dev/null > Packages
# add to apt
echo "deb file:${packagedir}v1.0.3/ ./" > /etc/apt/sources.list.d/99naemon.list
# install (will show up as untrusted, since this is not gpg signed)
apt-get update && apt-get install naemon

Unsupported markdown engine

Got this mail automatically after fixing a typo on the page:


The page build completed successfully, but returned the following warning:

You are currently using the 'redcarpet' Markdown engine, which is no longer supported by GitHub Pages and may cease working at any time. To ensure your site continues to build, remove the 'markdown' setting in your site's '_config.yml' file and confirm your site renders as expected. For more information, see https://help.github.com/articles/updating-your-markdown-processor-to-kramdown.

For information on troubleshooting Jekyll see:

https://help.github.com/articles/troubleshooting-jekyll-builds

If you have any questions you can contact us by replying to this email.

Small issues on bugs page

On the bugs page:

http://www.naemon.org/documentation/developer/bugs/

The sort slightly covers the "Id" column header.

bugs

Also, the bugs are sorted from lowest to highest. I personally like highest to lowest. I looked at the actual markdown which looks good.

https://github.com/naemon/naemon.github.io/blob/master/documentation/developer/bugs/index.md

Not positive how to make changes to the markdown/site so the markdown works better when formatted to HTML. I can help fix but would need some direction in how.

Wrong documentation for use_aggressive_host_checking

At least for me, it looks like that the documentation of use_aggressive_host_checking is a lie.
From what I learned in naemon/naemon-core#278 this option just swaps the return codes so that a plugin designed for service checks can also be used for host checks.

I scraped real quick through the code and it is just used in one `if``:
https://github.com/naemon/naemon-core/blob/492b8f81af4f57aba69c154881730b5843835647/src/naemon/checks_host.c#L507-L508

The documentation is talking about performance impacts and other things that just looks total wrong to me.
https://www.naemon.io/documentation/usersguide/tuning.html#avoid_aggressive_host_checking
https://www.naemon.io/documentation/usersguide/configmain.html#use_agressive_host_checking

If you guys agree, I will send a pull request to fix this.

Add search function for the documentation

It would be very helpful to have a search box on the page to be able to search the documentation without relying on external search providers such as google or duckduckgo.

Style issues on Plugin API page

When you scroll down on the Plugin API page eventually you get to the part where the documentation explains the contents of macros. The data is rather large and can mingle with the TOC on the side.

pluginapi

I'm using Chrome as my browser. Have not tested on any other browsers.

Not positive how to make changes to the markdown/site so the markdown works better when formatted to HTML. I can help fix but would need some direction in how.

Sticky acknowledgements wrongly documented

http://www.naemon.org/documentation/developer/externalcommands/acknowledge_svc_problem.html

"If the ‘sticky’ option is set to two (2), the acknowledgement will remain until the service returns to an OK state"

This is incorrect in the sense that if you set this option to 1, it's still enabled, and behaves just like if it's a 2.
The correct documentation would be:
"If the ‘sticky’ option is set to anything other than zero (0), the acknowledgement will remain until the service returns to an OK state"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.