Skip to content

Commit

Permalink
added filter and listing docs, better wording, use active voice
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinpapst committed Feb 21, 2025
1 parent 714ff44 commit 4dc91e9
Show file tree
Hide file tree
Showing 8 changed files with 92 additions and 33 deletions.
44 changes: 34 additions & 10 deletions collections/_documentation/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ title: Activities
description: Activities in Kimai
---

Activities describe the type of work performed during a time-record.
Activities (usually) describe the type of work performed.

## Activity types
The activity administration can be found at `Administration > Activities`.

Kimai supports two activity types: `global` and `project specific`.
## Create an activity

### Project specific activities
You can create activities from the `activity listing` page or from a `project detail` page.

These activities are linked to one project and can only be selected when working on that specific project.
Kimai supports two activity types: `global` and `project specific` activities.

### Project specific

Project specific activities are linked to one project and can only be selected when working on that specific project.

### Global activities

Expand All @@ -24,7 +28,7 @@ The choice of activities depends on your industry and workflow requirements.

Projects have a configuration flag to disallow global activity usage.

### Changing the activity type
### Change activity type

Once created, activities have limited type modification options:
- Project specific activities can be converted to global by clearing the project dropdown
Expand All @@ -41,7 +45,7 @@ If you need to change an activity's assignment nevertheless, follow these steps:
4. Use batch-update to assign the new activity
5. Delete the old activity once no timesheets use it

## Managing activities
## Manage activities

### Colors

Expand Down Expand Up @@ -88,7 +92,25 @@ Activities follow a hierarchical permission model:
- Accessible to all users if no teams are assigned at any level (activity, project, customer)
- When a team is assigned to the activity, only team members can use it, while also respecting the project and customer teams

## Filter and search
## Activity listing

{% include docs-image.html src="/images/documentation/activity-filter.webp" title="Activity toolbar filter" width="700px" %}

The **Visible** filter in the toolbar has three states:
- `Yes` - all visible activities: the activity itself and (if non-global) its project and customer are visible
- `No` - all activities that are exclusively invisible by their own visibility state
- `Both` - all activities: not filtering on their own or its project and customer visibility

### Invisible activities

Activities can be invisible. By default, only visible activities will be shown.
But you can use the activity filter to show all or only invisible activities.

Invisible activity will be highlighted in the listing table:

{% include docs-image.html src="/images/documentation/listing-invisible-entry.webp" title="Visible and invisible activities in the activity listing" width="700px" %}

### Filter and search

Available filters:
- `customer`
Expand All @@ -102,9 +124,11 @@ Free text search applies to:

{% include snippets/search-custom-field.md %}

## Deleting an activity
### Delete an activity

Activities can be deleted from the `Activity listing` view.

Delete activities via `Administration > Activities`. Consider using visibility settings instead of deletion for used activities.
{% alert danger %}Usually it is not a good idea to delete an activity that was used before, as all linked timesheets will be deleted as well. Consider to switch the visibility instead to hide it.{% endalert %}

Use the row context menu to access the delete option. The system will either:
- Confirm safe deletion for unused activities
Expand Down
34 changes: 27 additions & 7 deletions collections/_documentation/customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ description: Customers in Kimai

Customers in Kimai are used to manage project and activities, which are then used for time-records.

It is best-practice to have a customer for your own company, to track times for administrative and other internal work.
The customer administration can be found at `Administration > Customers`.

{% alert info %}It is best-practice to have a customer for your own company, to track times for administrative and other internal work.{% endalert %}

## Creating a customer
## Create a customer

Default values for new customers can be configured at [System > Settings]({% link _documentation/configurations.md %}).

## Managing customers
## Manage customers

### Colors

Expand Down Expand Up @@ -66,7 +68,25 @@ The visibility filter in the toolbar has three state:
- Accessible to all users if no teams are assigned
- If a team is assigned to the project, only team members can use it

## Filter and search
## Customer listing

{% include docs-image.html src="/images/documentation/customer-filter.webp" title="Customer toolbar filter" width="700px" %}

The **Visible** filter in the toolbar has three states:
- `Yes` - all visible customer
- `No` - all invisible customer
- `Both` - all customer

### Invisible customers

Customers can be invisible. By default, only visible customers will be shown.
But you can use the customer filter to show all or only invisible customers.

Invisible customers will be highlighted in the listing table:

{% include docs-image.html src="/images/documentation/listing-invisible-entry.webp" title="Visible and invisible customers in the customer listing" width="700px" %}

### Filter and search

The search supports filtering by the fields:
- `visibility`
Expand All @@ -82,11 +102,11 @@ Besides these filters, you can query for a free search term, which will be searc

{% include snippets/search-custom-field.md %}

## Deleting a customer
### Delete a customer

Customers can be deleted from the Customer listing view via `Administration > Customers`.
Customers can be deleted from the `Customer listing` view.

Usually it is not a good idea to delete a used customer, consider to switch the visibility instead to hide it.
{% alert danger %}Usually it is not a good idea to delete a customer that was used before, as all linked projects, activities and timesheets will be deleted as well. Consider to switch the visibility instead to hide it.{% endalert %}

Right-click on a row (or open the action dropdown at the end of it) to see all available actions for the selected customer.
The last action in the list is `Delete` - once you click it you wil get a feedback screen which either tells you that the
Expand Down
47 changes: 31 additions & 16 deletions collections/_documentation/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ description: Projects in Kimai

Projects in Kimai are assigned to customers and are linked to activities, which are then used for time-records.

## Creating a project
The project administration can be found at `Administration > Projects`.

## Create a project

There is a configuration (can be configured at [System > Settings]({% link _documentation/configurations.md %})), which allows to copy teams of the current user to newly created projects.
This is mostly useful when teamleads manage their own projects and should have immediate access to them after creation.

## Managing projects
## Manage projects

### Colors

Expand Down Expand Up @@ -51,24 +53,37 @@ By toggling the visibility on a project, you:
- hide the activities for this project from the default list in the activities administration

Please note:
- all currently linked objects will still show the project in the dropdown as pre-selected option
- you can still change the project on timesheet records and activities, which used it before
- you cannot create new activities for this project
- you cannot create new timesheet records for this project
- you can still access the hidden entries by changing the visibility filter on the toolbars

The visibility filter in the toolbar has three state:
- Visible: Yes (all projects that are "really" visible, meaning: the project and linked customer are visible)
- Visible: No (all projects that are exclusively invisible by their own visibility state)
- Visible "empty" (all projects: not filtering on their own or the customers visibility)
- All currently linked objects will still show the project in the dropdown as pre-selected option
- You can still change the project on timesheet records and activities, which used it before
- You cannot create new activities for this project
- You cannot create new timesheet records for this project
- You can still access invisible projects by changing the visibility filter on the listing view

### Permissions

- Inherit permissions from their linked customer
- Accessible to all users if no teams are assigned at customer and project level
- If a team is assigned to the project, only team members can use it, while also respecting the customer teams

## Filter and search
## Project listing

{% include docs-image.html src="/images/documentation/project-filter.webp" title="Project toolbar filter" width="700px" %}

The **Visible** filter in the toolbar has three states:
- `Yes` - all visible projects: the project itself and its customer are visible
- `No` - all projects that are exclusively invisible by their own visibility state
- `Both` - all projects: not filtering on their own or the customer visibility

### Invisible projects

Projects can be invisible or inactive (due to end or start date). By default, only visible projects will be shown.
But you can use the project filter to show all or only invisible projects.

Invisible projects will be highlighted in the listing table:

{% include docs-image.html src="/images/documentation/project-listing-visibility.webp" title="Visible and invisible projects in the project listing" width="700px" %}

### Filter and search

The search supports filtering by the fields:
- `customer`
Expand All @@ -81,11 +96,11 @@ Besides these filters, you can query for a free search term, which will be searc

{% include snippets/search-custom-field.md %}

## Deleting a project
### Delete a project

Projects can be deleted from the Project listing view via `Administration > Projects`.
Projects can be deleted from the `Project listing` view.

Usually it is not a good idea to delete a used project, consider to switch the visibility instead to hide it.
{% alert danger %}Usually it is not a good idea to delete a project that was used before, as all linked activities and especially timesheets will be deleted as well. Consider to switch the visibility instead to hide it.{% endalert %}

Right-click on a row (or open the action dropdown at the end of it) to see all available actions for the selected project.
The last action in the list is `Delete` - once you click it you wil get a feedback screen which either tells you that the
Expand Down
Binary file added images/documentation/activity-filter.webp
Binary file not shown.
Binary file added images/documentation/customer-filter.webp
Binary file not shown.
Binary file added images/documentation/listing-invisible-entry.webp
Binary file not shown.
Binary file added images/documentation/project-filter.webp
Binary file not shown.
Binary file not shown.

0 comments on commit 4dc91e9

Please sign in to comment.