improve docs: restructure file structure, show toc always

.htaccess

@@ -7,8 +7,9 @@ rewrite ^/en/alternative-to-traggo$ /en/traggo-alternative permanent;
 rewrite ^/documentation/2.0/api-pagination.html$ /documentation/api-pagination.html permanent;
 rewrite ^/v1/administration.html$ /documentation/chapter-manual.html permanent;
 rewrite ^/documentation/branding.html$ /documentation/configurations.html permanent;
-rewrite ^/documentation/team/$ /documentation/create-release.html permanent;
-rewrite ^/v1/team.html$ /documentation/create-release.html permanent;
+rewrite ^/documentation/team/$ /documentation/ permanent;
+rewrite ^/documentation/create-release.html$ /documentation/ permanent;
+rewrite ^/v1/team.html$ /documentation/ permanent;
 rewrite ^/documentation/developer/documentation.html$ /documentation/developers.html permanent;
 rewrite ^/documentation/developer/introduction.html$ /documentation/developers.html permanent;
 rewrite ^/documentation/development/installation.html$ /documentation/developers.html permanent;

_data/feature.yml

@@ -20,7 +20,7 @@
     featured: true
 
 -   name: multi-language
-    documentation: "_documentation/translations.md"
+    documentation: "_documentation/developer/translations.md"
     hosted: true
     oss: true
     icon: bx-chat
@@ -83,7 +83,7 @@
     featured: true
 
 -   name: api
-    documentation: "_documentation/rest-api.md"
+    documentation: "_documentation/developer/rest-api.md"
     hosted: true
     oss: true
     icon: bxs-file-json
@@ -173,7 +173,7 @@
     featured: false
 
 -   name: theming
-    documentation: "_documentation/theme.md"
+    documentation: "_documentation/developer/theme.md"
     hosted: true
     oss: true
     featured: false

_data/menu-documentation.yml

@@ -69,7 +69,7 @@ on-premise:
             description: Log in to Kimai using external identity provider
             pages: [ ldap, saml, saml-azure, saml-google, saml-keycloak, saml-authentik, saml-adfs ]
 developer:
-    slug: developers
+    slug: chapter-developer
     icon: bx bx-code-alt
     translation: docu-developer
     chapter:
@@ -82,9 +82,9 @@ developer:
             icon: bx bx-git-branch
             name: Create plugins
             description: Creating custom plugins, extending Kimai, using internal APIs
-            pages: [ plugins, translations, meta-fields, theme, store, migration-v2 ]
+            pages: [ developers, extending-kimai, plugins, translations, meta-fields, theme, store, migration-v2 ]
         -   id: extend
             icon: bx bxs-balloon
             name: Technical background
             description: Background info and technical correlations
-            pages: [ bughunter, permission-structure, sql-examples, redis, create-release ]
+            pages: [ bughunter, permission-structure, sql-examples, redis ]

_docu_versioned/1.13/reporting.md

@@ -1,7 +1,6 @@
 ---
 title: Reporting
 description: Reporting feature of Kimai
-toc: true
 canonical: /documentation/reporting.html
 ---
 

_docu_versioned/1.14/activity.md

@@ -1,7 +1,6 @@
 ---
 title: Activities
 description: Activities in Kimai
-toc: true
 canonical: /documentation/activity.html
 ---
 
@@ -11,7 +10,7 @@ Activities in Kimai are meant to explain the kind of work done for a specific ta
 
 Activities can have two different types: `global` and `project specific`.  
 
-{% include alert.html icon="fas fa-exclamation" type="warning" alert="Activities cannot be linked to a customer, the customer field in the edit form is only a filter for the project list." %}
+{% include alert.html icon="alarm-exclamation" type="warning" alert="Activities cannot be linked to a customer, the customer field in the edit form is only a filter for the project list." %}
 
 ### Project specific 
 
@@ -68,7 +67,7 @@ Besides these filters, you can query for a free search term, which will be searc
 - `name`
 - `comment`
 
-Additionally you can filter for [custom fields]({% link _documentation/meta-fields.md %}) by using a search phrase like `location:homeoffice`.
+Additionally you can filter for [custom fields]({% link _documentation/plugin-custom-fields.md %}) by using a search phrase like `location:homeoffice`.
 This would find all activities with the custom field `location` matching the term `homeoffice`.
 
 The search terms will be found within the full value, so searching for `office` would find:

_docu_versioned/1.14/developers.md

@@ -1,7 +1,6 @@
 ---
 title: Developers
 description: Developer documentation - run, develop, extend and build for Kimai 
-toc: true
 canonical: /documentation/developers.html
 ---
 
@@ -149,7 +148,7 @@ Kimai code-styles are configured in [.php_cs.dist]({{ site.kimai_v2_file }}/.php
 
 ## Translations
 
-Read more about [languages and translations]({% link _documentation/translations.md %}).
+Read more about [languages and translations]({% link _documentation/developer/translations.md %}).
 
 ## Extending the navigation bar
 
@@ -380,7 +379,7 @@ The configuration for "hourly-rates multiplication factors" can be fetched from
 
 ## Adding custom fields (meta fields)
 
-See [meta fields]({% link _documentation/meta-fields.md %}) documentation.
+See [meta fields]({% link _documentation/developer/meta-fields.md %}) documentation.
 
 ## Adding UserPreference
 
@@ -419,7 +418,7 @@ These events are trigger on all pages, including the security layout.
 New plugins usually ship with a set of own permissions. You should always assign these permissions at least to the `ROLE_SUPER_ADMIN`.
 By doing so, you register the permission in the system and they become available in the [permission admin screen]({% link _documentation/permissions.md %}). 
 
-You register new permission through your [plugins extension class]({% link _documentation/plugins.md %}), by using the `PrependExtensionInterface`:
+You register new permission through your [plugins extension class]({% link _documentation/developer/plugins.md %}), by using the `PrependExtensionInterface`:
 
 ```php
 namespace KimaiPlugin\YourBundle\DependencyInjection;

_docu_versioned/1.14/docker.md

@@ -1,7 +1,6 @@
 ---
 title: Docker
 description: Running Kimai inside docker
-toc: true
 canonical: /documentation/docker.html
 ---
 

_docu_versioned/1.14/export.md

@@ -1,7 +1,6 @@
 ---
 title: Export
 description: Export your timesheet data with Kimai into several different formats
-toc: true
 canonical: /documentation/export.html
 ---
 

_docu_versioned/1.14/fresh-ubuntu-18.md

@@ -1,7 +1,6 @@
 ---
 title: "Install Kimai on a fresh Ubuntu 18.04 LTS"
 description: "How to install Kimai on a brand new Ubuntu 18.04 with database, webserver and SSL certificate"
-toc: true
 canonical: /documentation/fresh-ubuntu-18.html
 ---
 

_docu_versioned/1.14/fresh-ubuntu-20.md

@@ -1,7 +1,6 @@
 ---
 title: "Install Kimai on a fresh Ubuntu 20.04 LTS"
 description: "How to install Kimai on a brand new Ubuntu 20.04 with database, webserver and SSL certificate"
-toc: true
 canonical: /documentation/fresh-ubuntu-20.html
 ---
 

_docu_versioned/1.14/installation.md

@@ -1,7 +1,6 @@
 ---
 title: Installation
 description: How to install Kimai on your server with git, composer and SSH or FTP
-toc: true
 canonical: /documentation/installation.html
 ---
 

_docu_versioned/1.14/invoices.md

@@ -1,7 +1,6 @@
 ---
 title: Invoices
 description: Create invoices directly within Kimai from timesheet data in several formats 
-toc: true
 canonical: /documentation/invoices.html
 ---
 
@@ -36,7 +35,7 @@ Example: to get a three digit long string with year counter use `{cy,3}`, which
 Characters outside the replacer may **not** include `{` and `}`.
 {% endcapture %}
 {% assign additional_chars = additional_chars| markdownify %}
-{% include alert.html icon="fas fa-exclamation" type="warning" alert=additional_chars %}
+{% include alert.html icon="alarm-exclamation" type="warning" alert=additional_chars %}
 
 To change the format, look out for the {% include demo-action-button.html icon="bx bx-cog" %} icon in the invoice screen, or change it from the `System configurations`.
 
@@ -138,7 +137,7 @@ Be aware of the following rules:
 - You can hide the default templates by setting the key `kimai.invoice.defaults` to an empty array / null
 - New or updated templates can be uploaded via the UI
 
-{% include alert.html icon="fas fa-exclamation" type="warning" alert="Do NOT change the default templates, but copy the file and save it (with a new filename) at var/invoices/" %}
+{% include alert.html icon="alarm-exclamation" type="warning" alert="Do NOT change the default templates, but copy the file and save it (with a new filename) at var/invoices/" %}
 
 After you changed an invoice template, you have to [clear the cache]({% link _documentation/cache.md %}) to see the results:
 
@@ -306,7 +305,7 @@ The documents which are rendered passively (ODS, XLSX, CSV, DOCX) can use the fo
 | ${customer.mobile} | The customers mobile number (since 1.9) |
 | ${customer.email} | The customers email address (since 1.9) |
 | ${customer.fax} | The customers fax number (since 1.9) |
-| ${customer.meta.x} | The customer [meta field]({% link _documentation/meta-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${customer.meta.foobar}`. Only available if the field is visible.  |
+| ${customer.meta.x} | The customer [meta field]({% link _documentation/plugin-custom-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${customer.meta.foobar}`. Only available if the field is visible.  |
 
 ### Timesheet entry variables 
 
@@ -345,7 +344,7 @@ For each timesheet entry you can use the variables from the following table.
 | ${entry.project_id} | Project ID | 10 |
 | ${entry.customer} | Customer name | Acme Studios |
 | ${entry.customer_id} | Customer ID | 3 |
-| ${entry.meta.X} | The [meta field]({% link _documentation/meta-fields.md %}) named `X` (if visible)  |
+| ${entry.meta.X} | The [meta field]({% link _documentation/plugin-custom-fields.md %}) named `X` (if visible)  |
 | ${entry.type} | The type of this entry (plugins can add custom types) | timesheet |
 | ${entry.category} | The category of this entry (plugins can add custom types) | work |
 
@@ -368,7 +367,7 @@ If a project was selected in the invoice filter (search form) the following vari
 | ${project.budget_time} | The projects time-budget as seconds (since 1.7) |
 | ${project.budget_time_decimal} | The projects time-budget in decimal format (with localized separator) (since 1.7) |
 | ${project.budget_time_minutes} | The projects time-budget in minutes with no decimals (since 1.7) |
-| ${project.meta.x} | The project [meta field]({% link _documentation/meta-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${project.meta.foobar}`. Only available if the field is visible.  |
+| ${project.meta.x} | The project [meta field]({% link _documentation/plugin-custom-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${project.meta.foobar}`. Only available if the field is visible.  |
 
 If you selected more than one project in the search, you will have further variables called `${project.1.X}`, `${project.2.X}` and so on.
 The order is not guaranteed, so it is not recommended to rely on those variables.  
@@ -382,7 +381,7 @@ If an activity was selected in the invoice filter (search form) the following va
 | ${activity.id} | The activity ID |
 | ${activity.name} | The activity name |
 | ${activity.comment} | The activity name |
-| ${activity.meta.x} | The activity [meta field]({% link _documentation/meta-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${activity.meta.foobar}`. Only available if the field is visible.  |
+| ${activity.meta.x} | The activity [meta field]({% link _documentation/plugin-custom-fields.md %}) named `X`. The internal name `X` needs to be used in lowercase letters, eg. `FooBar` will be available as `${activity.meta.foobar}`. Only available if the field is visible.  |
 
 If you selected more than one project in the search, you will have further variables called `${activity.1.X}`, `${activity.2.X}` and so on.
 The order is not guaranteed, so it is not recommended to rely on those variables.  

_docu_versioned/1.14/ldap.md

@@ -1,7 +1,6 @@
 ---
 title: LDAP
 description: How to use an LDAP directory server with Kimai
-toc: true
 canonical: /documentation/ldap.html
 ---
 

_docu_versioned/1.14/migration-v1.md

@@ -1,7 +1,6 @@
 ---
 title: Upgrade to Kimai 2 from v1
 description: Install Kimai 2 and import your existing timesheet data from Kimai 1
-toc: true
 canonical: /documentation/migration-v1.html
 ---
 
@@ -11,7 +10,7 @@ This documentation covers all necessary steps to migrate from Kimai 1 to Kimai 2
 You can <a href="{% link _store/keleo-installation-support.md %}">get professional support</a> if you are not sure about performing the upgrade yourself. 
 {% endcapture %}
 
-{% include alert.html type="success" icon="fas fa-shipping-fast" alert=upgrade_note %} 
+{% include alert.html type="success" icon="support" alert=upgrade_note %} 
 
 ## Introduction
 

_docu_versioned/1.14/reporting.md

@@ -1,7 +1,6 @@
 ---
 title: Reporting
 description: Reporting feature of Kimai
-toc: true
 canonical: /documentation/reporting.html
 ---
 

_docu_versioned/1.14/saml.md

@@ -1,7 +1,6 @@
 ---
 title: SAML
 description: How to use SAML identity provider with Kimai
-toc: true
 canonical: /documentation/saml.html
 ---
 

_docu_versioned/1.14/tags.md

@@ -1,7 +1,6 @@
 ---
 title: Tags
 description: Using tags to group timesheet entries
-toc: true
 canonical: /documentation/tags.html
 ---
 

_docu_versioned/1.14/teams.md

@@ -1,7 +1,6 @@
 ---
 title: Teams
 description: Configure teams to limit access to projects and customers 
-toc: true
 canonical: /documentation/teams.html
 ---
 
@@ -10,7 +9,7 @@ Teams allow you to organize your users in groups and limit access to customers a
 A team consists of a Teamlead and an unlimited amount of team members. The teamlead has access to all contents and timesheets of the team. 
 Every content object can be linked to an arbitrary amount of teams.
 
-{% include alert.html type="warning" icon="fas fa-exclamation" alert="Using teams is optional. But once a team is assigned to a customer or project, access to this object and its children is limited." %}
+{% include alert.html type="warning" icon="alarm-exclamation" alert="Using teams is optional. But once a team is assigned to a customer or project, access to this object and its children is limited." %}
 
 If you want to limit the access to Kimai functionality instead of content, 
 please read the [permissions documentation]({% link _documentation/permissions.md %}).

_docu_versioned/1.14/theme.md

@@ -1,7 +1,6 @@
 ---
 title: Theme
 description: Theme related configuration and developer documentation for Kimai
-toc: true
 canonical: /documentation/theme.html
 ---
 

_docu_versioned/1.14/timesheet.md

@@ -1,7 +1,6 @@
 ---
 title: Timesheet
 description: View and manage your time-tracking data in the timesheet view
-toc: true
 canonical: /documentation/timesheet.html
 ---
 
@@ -151,7 +150,7 @@ entry (an error message is shown, indicating why it is not possible to start ano
 
 ## 12-hour am/pm format
 
-Want to use the 12 hour format? Read the [i18n docu]({% link _documentation/translations.md %}).
+Want to use the 12 hour format? Read the [i18n docu]({% link _documentation/developer/translations.md %}).
 
 ## Descriptions with Markdown
 
@@ -246,7 +245,7 @@ The search drop-down supports filtering by the fields:
 Besides these filters, you can query for a free search term, which will be searched in the fields:
 - `description`
 
-Additionally, you can filter for [custom fields]({% link _documentation/meta-fields.md %}) by using a search phrase like `location:homeoffice`.
+Additionally, you can filter for [custom fields]({% link _documentation/plugin-custom-fields.md %}) by using a search phrase like `location:homeoffice`.
 This would find all timesheets with the custom field `location` matching the term `homeoffice`.
 
 The search terms will be found within the full value, so searching for `office` would find:

_docu_versioned/1.14/users.md

@@ -1,7 +1,6 @@
 ---
 title: Users
 description: User, roles and the authentication, registration and security system in Kimai
-toc: true
 canonical: /documentation/users.html
 ---
 

_docu_versioned/1.15/i18n-am-pm.md

@@ -1,7 +1,6 @@
 ---
 title: "Switch to AM/PM"
 description: Using AM/PM instead of 24h-format
-toc: false
 canonical: /documentation/i18n-am-pm.html
 ---