Git Product home page Git Product logo

checkmk-docs's Introduction

The official documentation for Checkmk

Welcome

This documentan is based on Asciidoctor and is automatically provided as HTML on docs.checkmk.com. On the one hand it is possible through this repository to convert the documentation into another file format (e.g. through the Makefile) and gives you the opportunity on the other hand to contribute on the content. We will provide more information about how this is done in the next sections.

How to contribute per pull request (PR)

There are bugs and typos even in the best work or a topic is not explained in a dimension that would be sufficient. So if you are interested in making the documentation of Checkmk even more better, we are happy to welcome you and of course try to work on corresponding PRs as soon as possible. But every project has it’s requirements and demands and this is no exception. What to consider if you want to contribute and also guides for making your contribution as easy as possible, will be described in the following sections:

Introduction

Basic principles about what a good documentation looks like in our point of view.

Structure of this git

Here is explained how we think the repository is structured.

Guidance for writing

Best-Practices and guidance for writing articles in this documentation itself.

How to setup your development

Instructions to setup the most common code editors and for converting adoc files to HTML locally.

Feedback

You discovered a problem, bug or typo but you are willing, do not have time or even are not confident enough to contribute directly on this project? Please write us a feedback to [email protected].

checkmk-docs's People

Contributors

ajoga avatar bili123 avatar frans-fuerst avatar godspeed-you avatar larsmichelsen avatar mo-ki avatar mschlenker avatar reduxionist avatar sebkir avatar thomaskoslowski avatar

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.