EKG/Maturity

This repository contains the Markdown based source documents of EKG/Maturity, the Maturity Model for the EKG.

Website

The content in this repository is used to generate a website (https://maturity.ekgf.org) using the MkDocs tool. All content is in Markdown format and can be found in the ./docs or ./docs-fragments directories.

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

For members of the EKGF there are a number of Slack channels:

• #ekg-maturity-general
• #ekg-maturity-pillar-business
• #ekg-maturity-pillar-organization
• #ekg-maturity-pillar-data
• #ekg-maturity-pillar-technology

Where to find the content?

The "raw" Markdown source documents (see Markdown below for an explanation) can be found in the /docs directory and more specifically in the /docs-fragments directory.

Markdown

Markdown is a lightweight markup language for creating formatted text using a plain-text editor.

For a quick overview of what you need to understand of Markdown look at this "Markdown cheat sheet".

Where is this published?

From this git repository we generate a PDF document. Two in fact: the "editors-version" which contains annotations and "todo's" and the "release-version" without those annotations.

You can find the published version at https://ekgf.org/maturitymodel.

!!! note

Please note that we're in the process of generating a website for the
maturity model here: [https://maturity-model.ekgf.org](https://maturity-model.ekgf.org)

For members of the EKGF there's also a Slack channel called #ekg-mm-latest where both PDFs are published every time someone pushes a change into this repository.

!!! note

Soon we'll also be publishing this content as HTML.

Github

This repository resides on GitHub as https://github.com/EKGF/ekg-maturity.

How to clone?

For advanced users who often contribute to this repository, it's best to create a so-called git clone of this git repository on the local drive which allows any given LaTeX editor to be used locally to create new content.

First, install git and/or GitHub Desktop.

How to create a clone of the GitHub repo:

cd ~ # go to your home directory or the directory where you want your git clones to be
git clone https://github.com/EKGF/ekg-maturity
cd ekg-maturity
make install

Editors

Any text editor will do. Edit the .md files in this repository, they're just ASCII files.

IntelliJ Idea or CLion

• IntelliJ has by far the best "git merge" options of any tool out there, if you're planning to write a lot of content then it makes sense to install the "community edition" (free) and get used to IntelliJ.

Install components

If you want to run the website on your local machine to see your content before committing it to GitHub you can do so by first installing all the components around "MkDocs" which is a Python program with a lot of sub-components.

You can install this as follows:

make docs-install

The above command assumes you're doing this on a MacOS machine. It has not been tested on Windows or Linux (but it may work).

Build steps

To construct the website from all the various Markdown documents in this repository we use the mkdocs command which can be installed by executing make docs-install from the root directory of your git clone.

Then building the static HTML website can be done with this command:

make docs-build

Then serving the static HTML website locally on your own computer:

make docs-serve