Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 3.25 KB

git.adoc

File metadata and controls

61 lines (41 loc) · 3.25 KB

Structure and handling of this repository

There are several directories and some rules for creating articles and related materials. The most important ones are explained here.

Directories

On the top level there are the following directories:

de

The place for all articles in German language. Currently all articles are first written in German and then translated to English.

en

The place for all articles in English language, as soon as the German version is ready.

images

The images used in the articles (graphics, screenshots, icons) are stored here: Graphics and screenshots in a flat hierarchy and the icons used in the body text in a height of 20 pixels in the subdirectory icons.

attributes

To make writing easier and to standardize certain terminology and formatting, general attributes are defined and adjusted here.

contrib

Contains the documentation for using the repository.

Files

checkmk.css

This stylesheet file is an adapted version of the file used for publishing. It can be used to generate a live preview when writing in the editor, which is as close as possible to the published page in the target format.

Branches

The documentation of Checkmk is version-based, but not edition-based. On the one hand, this means that the differences between CRE Checkmk Raw Edition and the commercial editions are described in the same manual.

There is a separate branch for each stable, published version. This is to be used if the article or correction applies to an already published version of Checkmk. Conversely, the master is always used for the version of Checkmk that is currently under development and has not yet been officially released.

git commit messages

Regardless of whether it is regular tribe29 work or pull requests (PRs), a commit message should always be helpful to understand what was done in the commit. For this purpose, it may also sometimes be necessary to provide a more detailed description to justify the content of the change. Especially in the case of a PR, it makes tribe29’s work much easier if they can quickly understand the reason for a change.

Some keywords in the commit messages are used to track the translation status. If one of the following keywords is used at the beginning of a commit, it has the following effect:

only-de

This commit only affects German, does not need to be translated to English, and is not considered for translation status.

only-en

The counterpart to only-de.

content-sync

The committed article is completely synchronous in content in both languages. Any commits made before this date in either language will be automatically acknowledged and ignored in the future. This keyword is also used to indicate the commit of an article for translation, i.e.: The content is in sync, but not necessarily already translated.

For examples on how to use these git commit messages, see the translation topic.