Skip to content

Commit

Permalink
doc: Move chapters
Browse files Browse the repository at this point in the history
  • Loading branch information
lippserd committed May 11, 2020
1 parent 0892d1e commit eca9f77
Show file tree
Hide file tree
Showing 37 changed files with 39 additions and 39 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Documentation
-------------

### Basics
* [Installation](doc/01-Installation.md)
* [Getting Started](doc/02-Getting-Started.md)
* [Create your first process node](doc/03-Create-your-first-process-node.md)
* [Importing Processes](doc/04-Importing-Processes.md)
* [Customize Node Order](doc/05-Customize-Node-Order.md)
* [Installation](doc/02-Installation.md)
* [Getting Started](doc/03-Getting-Started.md)
* [Create your first process node](doc/04-Create-your-first-process-node.md)
* [Importing Processes](doc/05-Importing-Processes.md)
* [Customize Node Order](doc/06-Customize-Node-Order.md)

### Web Components
* [Breadcrumb](doc/12-Web-Components-Breadcrumb.md)
Expand Down
6 changes: 3 additions & 3 deletions doc/01-Installation.md → doc/02-Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,16 @@ icingacli module enable businessprocess

Or go to your Icinga Web 2 frontend, choose `Configuration` -> `Modules`...

![Choose Configuration - Modules](screenshot/01_installation/101_menu-configuration-modules.png)
![Choose Configuration - Modules](screenshot/02_installation/101_menu-configuration-modules.png)

...choose the `businessprocess` module and `enable` it:

![Enable the module](screenshot/01_installation/102_enable-module.png)
![Enable the module](screenshot/02_installation/102_enable-module.png)

It might afterwards be necessary to refresh your web browser to be sure that
newly provided styling is loaded.

Create your first Business Process definition
---------------------------------------------

That's it, *Business Process* is now ready for use. Please read more on [how to get started](02-Getting-Started.md).
That's it, *Business Process* is now ready for use. Please read more on [how to get started](03-Getting-Started.md).
22 changes: 11 additions & 11 deletions doc/02-Getting-Started.md → doc/03-Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,42 @@
Once you enable the *Business Process* module, it will pop up in your menu.
When you click on it, it will show you a new Dashboard:

![Empty Dashboard](screenshot/02_getting-started/0201_empty-dashboard.png)
![Empty Dashboard](screenshot/03_getting-started/0201_empty-dashboard.png)

A new Business Process configuration
-------------------------------------------

From here we choose to create a new *Business Process configuration*:

![New Business Process](screenshot/02_getting-started/0202_create-new-configuration.png)
![New Business Process](screenshot/03_getting-started/0202_create-new-configuration.png)

Let's have a look at the single fields:

### Configuration name

![Configuration name](screenshot/02_getting-started/0203_create-new_name.png)
![Configuration name](screenshot/03_getting-started/0203_create-new_name.png)

The Business Process definition will be stored with this name. This is going to
be used when referencing this process in URLs and in Check Commands.

### Title

![Configuration name](screenshot/02_getting-started/0204_create-new_title.png)
![Configuration name](screenshot/03_getting-started/0204_create-new_title.png)

You might optionally want to provide an additional title. In that case the title
is shown in the GUI, while the name is still used as a reference. The title will
default to the name.

### Description

![Description](screenshot/02_getting-started/0205_create-new_description.png)
![Description](screenshot/03_getting-started/0205_create-new_description.png)

Provide a short description explaining within 100-150 character what this
configuration provides. This will be shown on the Dashboard.

### Backend

![Backend](screenshot/02_getting-started/0206_create-new_backend.png)
![Backend](screenshot/03_getting-started/0206_create-new_backend.png)

**Hint:** *Usually this should not be changed*

Expand All @@ -50,7 +50,7 @@ provider for your Business Process.

### State Type

![State Type](screenshot/02_getting-started/0207_create-new_state-type.png)
![State Type](screenshot/03_getting-started/0207_create-new_state-type.png)

You can decide whether `SOFT` or `HARD` states should be the used as a base when
calculating the state of a Business Process definition.
Expand All @@ -60,7 +60,7 @@ calculating the state of a Business Process definition.
Business Process configurations can be linked to the Icinga Web 2 menu. Only the
first five configurations a user is allowed to see will be shown there:

![Add to menu](screenshot/02_getting-started/0208_create-new_add-to-menu.png)
![Add to menu](screenshot/03_getting-started/0208_create-new_add-to-menu.png)

That's all for now, click `Add` to store your new (still empty) Business Process
configuration.
Expand All @@ -70,11 +70,11 @@ Empty configuration

You are redirected to your newly created Business Process configuration:

![Empty configuration](screenshot/02_getting-started/0209_new-empty-configuration.png)
![Empty configuration](screenshot/03_getting-started/0209_new-empty-configuration.png)

From here we can now add as many deeply nested Business Processes as we want.
But let's first have a look at our Dashboard once again:

![New on Dashboard](screenshot/02_getting-started/0210_new-on-dashboard.png)
![New on Dashboard](screenshot/03_getting-started/0210_new-on-dashboard.png)

Now let's move on and [create your first Nodes](03-Create-your-first-process-node.md).
Now let's move on and [create your first Nodes](04-Create-your-first-process-node.md).
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ A *Business Process Node* consists of a *name*, *title*, an *operator* and one o
more child nodes. It can be a Root Node, child node of other Business Process
Nodes - or both.

![Empty Config](screenshot/03_first-root-node/0301_empty-config.png)
![Empty Config](screenshot/04_first-root-node/0301_empty-config.png)

Configuring our first node
--------------------------

To create our first *Business Process Node* we click the *Add* button. This
leads to the related configuration form:

![Add new Node](screenshot/03_first-root-node/0302_add-new-node.png)
![Add new Node](screenshot/04_first-root-node/0302_add-new-node.png)

First setting is the *Node name*, an identifier that must be unique throughout
all Nodes that are going to be defined. This identifier will be used in every
Expand All @@ -25,14 +25,14 @@ Check*.
As uniqueness sometimes leads to not-so-beautiful names, you are additionally
allowed to specify a title. This is what the frontend is going to show:

![Node Title](screenshot/03_first-root-node/0303_node-title.png)
![Node Title](screenshot/04_first-root-node/0303_node-title.png)

### Choose an operator

Every Business Process requires an *Operator*. This operator defines it's
behaviour, this specifies how it's very own state is going to be calculated:

![Operator](screenshot/03_first-root-node/0304_operator.png)
![Operator](screenshot/04_first-root-node/0304_operator.png)

### Specify where to display

Expand All @@ -41,7 +41,7 @@ to create a new *root node*. We could alternatively also create a sub process.
As we are currently not adding it to another Node, this would lead to an *Unbound
Node* that could be linked later on.

![Node Display](screenshot/03_first-root-node/0305_display.png)
![Node Display](screenshot/04_first-root-node/0305_display.png)

### Provide an optional Info URL

Expand All @@ -51,7 +51,7 @@ hints telling what should happen if outage occurs. You might not want to do so
for every single Node, but it might come in handy for your most important (top
level?) nodes:

![Node Info Url](screenshot/03_first-root-node/0306_info-url.png)
![Node Info Url](screenshot/04_first-root-node/0306_info-url.png)

That's it, your are ready to submit the form.

Expand All @@ -60,10 +60,10 @@ That's it, your are ready to submit the form.
You are now shown your first Business Process Node. A red bar reminds you that
your pending changes have not been stored yet:

![First Node created](screenshot/03_first-root-node/0307_first-node-created.png)
![First Node created](screenshot/04_first-root-node/0307_first-node-created.png)

You could now *Store the Configuration* or move on with adding additional nodes
to complete your configuration.

**Hint**: the blue arrow makes part of a breadcrumb showing your current position.
You might want to learn more about [breadcrumbs](12-Web-Components-Breadcrumb.md).
You might want to learn more about [breadcrumbs](12-Web-Components-Breadcrumb.md).
14 changes: 7 additions & 7 deletions doc/04-Importing-Processes.md → doc/05-Importing-Processes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,35 @@ to maintain it is possible to import processes from other configurations.
In order to be able to import a process create a root node first. You cannot
import processes into the root level.

![Subprocesses Only](screenshot/04_importing_nodes/0401_subprocesses_only.png)
![Subprocesses Only](screenshot/05_importing_nodes/0401_subprocesses_only.png)

Importing a Process
-------------------

Once the related configuration form is open, choose `Existing Process` and wait
for the form to refresh.

![Existing Process](screenshot/04_importing_nodes/0402_choose_existing_process.png)
![Existing Process](screenshot/05_importing_nodes/0402_choose_existing_process.png)

### Choose Configuration

You can now choose the configuration to import processes from. Or simply hit
`Next` to just utilize a process from the current configuration.

![Choose Configuration](screenshot/04_importing_nodes/0403_choose_configuration.png)
![Choose Configuration](screenshot/05_importing_nodes/0403_choose_configuration.png)

### Select Processes

Now select the processes you want to import and submit the form.

![Select Processes](screenshot/04_importing_nodes/0404_choose_process.png)
![Select Processes](screenshot/05_importing_nodes/0404_choose_process.png)

### Import Successful

You are now looking at the result. The process has been imported. Do not forget
to save your changes!

![Import Successful](screenshot/04_importing_nodes/0405_import_successful.png)
![Import Successful](screenshot/05_importing_nodes/0405_import_successful.png)

Navigation with Imported Processes
----------------------------------
Expand All @@ -46,11 +46,11 @@ You may have already noticed that the breadcrumbs integrate the hierarchy
of the imported process. Once you navigate further the actions below the
breadcrumbs change and don't permit to unlock editing.

![Seamless Breadcrumbs](screenshot/04_importing_nodes/0406_breadcrumb_integration.png)
![Seamless Breadcrumbs](screenshot/05_importing_nodes/0406_breadcrumb_integration.png)

To change imported processes you need to open them in their original
configuration first. To do so click on the arrow to the right which is
displayed in a tile's action urls in the upper left. While in tree view
these can be found at the very right of an process' row.

![Jump To Original](screenshot/04_importing_nodes/0407_jump_to_original.png)
![Jump To Original](screenshot/05_importing_nodes/0407_jump_to_original.png)
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ Make sure to unlock the configuration first to be able to reorder nodes.
To move a tile simply grab it with your mouse and drag it to the location you
want it to appear at.

![Grab Tile](screenshot/05_customize_node_order/0501_tiles_grab_tile.png)
![Drop Tile](screenshot/05_customize_node_order/0502_tiles_drop_at_location.png)
![Grab Tile](screenshot/06_customize_node_order/0501_tiles_grab_tile.png)
![Drop Tile](screenshot/06_customize_node_order/0502_tiles_drop_at_location.png)

### Tree View

While in tree view nodes can be moved the same way. You just have a narrower
area to grab them.

![Grab Row](screenshot/05_customize_node_order/0503_tree_grab_header.png)
![Drop Row](screenshot/05_customize_node_order/0504_tree_drop_at_location.png)
![Grab Row](screenshot/06_customize_node_order/0503_tree_grab_header.png)
![Drop Row](screenshot/06_customize_node_order/0504_tree_drop_at_location.png)

The tree view also has an advantage the tile view has not. It is possible to
move nodes within the entire hierarchy. But remember to unfold processes first,
Expand Down
2 changes: 1 addition & 1 deletion doc/21-Store-Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ be shown on every screen:

A click on *Dismiss* immediately throws away all unstored changes. A click on
*Store* brings you to the configuration form. You have seen this before, once
you created your [very first configuration](02-Getting-Started.md):
you created your [very first configuration](03-Getting-Started.md):

![Store Config](screenshot/21_store-config/2102_Store-Config.png)

Expand Down

0 comments on commit eca9f77

Please sign in to comment.