new content for the adminstraion with fixing image zooms

.vitepress/config.mts

@@ -17,39 +17,56 @@ export default defineConfig({
     sidebar: [
       {
         text: "Tracking",
+        base: "/docs/tracking/",
         items: [
-          { text: "Activities", link: "/docs/tracking/activities" },
-          { text: "Attendances", link: "/docs/tracking/attendances" },
-          { text: "Timesheet", link: "/docs/tracking/timesheet" },
+          { text: "Activities", link: "/activities" },
+          { text: "Attendances", link: "/attendances" },
+          { text: "Timesheet", link: "/timesheet" },
         ],
       },
       {
+        base: "/docs/",
         items: [
-          { text: "Analysis", link: "/docs/analysis" },
-          { text: "Statistics", link: "/docs/statistics" },
-          { text: "Projects", link: "/docs/projects" },
-          { text: "Users", link: "/docs/users" },
-          { text: "Profile", link: "/docs/profile" },
+          { text: "Analysis", link: "/analysis" },
+          { text: "Statistics", link: "/statistics" },
+          { text: "Projects", link: "/projects" },
+          { text: "Users", link: "/users" },
+          { text: "Profile", link: "/profile" },
         ],
       },
       {
         text: "Details",
+        base: "/docs/details",
         items: [
-          { text: "Filters", link: "/docs/details/filters" },
-          { text: "Estimated Effort", link: "/docs/details/estimated_effort" },
+          { text: "Filters", link: "/filters" },
+          { text: "Estimated Effort", link: "/estimated_effort" },
+        ],
+      },
+      {
+        text: "Administration",
+        base: "/docs/administration/",
+        items: [
+          { text: "Intro", link: "index.md" },
+          { text: "Users", link: "users.md" },
+          { text: "Customers", link: "customers.md" },
+          { text: "Projects", link: "projects.md" },
+          { text: "Tasks", link: "tasks.md" },
+          { text: "Locations", link: "locations.md" },
+          { text: "Public Holidays", link: "public-holidays.md" },
+          { text: "Absence Type", link: "absence-type.md" },
         ],
       },
     ],
     footer: {
       message:
-        'Adfinis Timed is released under the <a href="https://github.com/adfinis/timed-frontend/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a>.',
+        'Adfinis Timed is released under the <a href="https://github.com/adfinis/timed/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a>.',
       copyright: `Made with ❤️ by Adfinis 
       <br>
-      Copyright © 2019-${date.getFullYear()} <a href="https://github.com/adfinis/timed-frontend">Adfinis Timed</a>
+      Copyright © 2019-${date.getFullYear()} <a href="https://github.com/adfinis/timed">Adfinis Timed</a>
       `,
     },
     socialLinks: [
-      { icon: "github", link: "https://github.com/adfinis/timed-frontend" },
+      { icon: "github", link: "https://github.com/adfinis/timed" },
     ],
     search: {
       provider: "local",

components/contributors.vue

@@ -30,7 +30,7 @@ const data = reactive({
 });
 
 onMounted(async () => {
-    const users: GithubUser[] = await (await fetch('https://api.github.com/repos/adfinis/timed-frontend/contributors')).json();
+    const users: GithubUser[] = await (await fetch('https://api.github.com/repos/adfinis/timed/contributors')).json();
     data.contributors = users;
 });
 </script>

docs/administration/absence-type.md

@@ -0,0 +1,31 @@
+# Absence Type
+
+:::tip
+With Absence, you can allow your employees to add those absence to thier working time.
+:::
+
+## Create New Absence
+* go to [Django Admin Panel](/docs/administration/index.md#django-admin-panel).
+* under `EMPLOYMENT` section, you can find `Absence Type`, which will take you to the list of absence type.
+* in the top right, you can find `ADD ABSENCE TYPE` button.
+![New Absence Form](/adminstration/absence-type/new-absence-form.png)
+
+:::tip
+* The name field is required
+:::
+
+
+## Absence Fill Worktime Field
+
+Let's imagine that we are in Monday and there is an employee who worked for 3 hours.
+
+
+The employee have 100% contract which is 8 working hours per day
+
+And later he add an absence to the same day (Monday).
+
+* If `Fill Wroktime` is `checked` of the inserted absence, Timed will insert only 8 hours to his day record
+![Absence With Fill Worktime](/adminstration/absence-type/with.png)
+
+* If `Fill Wroktime` is`not checked` of the inserted absence, Timed will insert 8 hours (his full working day) with 3 hours of extra working time
+![Absence With Fill Worktime](/adminstration/absence-type/without.png)

docs/administration/customers.md

@@ -0,0 +1,18 @@
+# Customers
+
+
+## Create New Customer
+* Open Django Administration Panel
+    ![Django Admin Panel](/adminstration/django-admin-panel.png){data-zoomable}
+
+* you can see customers under project section.
+
+* click it, and in the top right of customers page, you can see `ADD CUSTOMER` button
+
+* then, fill this form with customer information
+![Django Admin Panel](/adminstration/customers/add-customer-form.png){data-zoomable}
+
+:::info
+* The `Name` field is required, but the other fields in the form are optional.
+* If the `Archived` field if checked, no one can create new reports with it.
+:::

docs/administration/index.md

@@ -0,0 +1,9 @@
+# Administration
+
+:::warning
+This section is only for the adminstration, the employees don't have access to this side
+:::
+
+## Django Admin Panel
+Most of the coming information is going to be inside `Django Admin Panel`
+![Django Admin Panel](/adminstration/django-admin-panel.png){data-zoomable}

docs/administration/locations.md

@@ -0,0 +1,15 @@
+# Locations
+
+The offices to which you can assign your employees are defined by location. Each office has its own set of working days, and its own [Public Holidays](/docs/administration/public-holidays.md).
+
+## Create New Location
+
+* go to [Django Admin Panel](/docs/administration/index.md#django-admin-panel)
+* and under `EMPLOYMENT` section, you can see `Locations`
+* in the top right of the screen, you can see `ADD LOCATION` button to go to new location form
+![New Location Form](/adminstration/locations/location-form.png){data-zoomable}
+
+:::tip
+* The location name is required
+* at least one working day is required
+:::

docs/administration/projects.md

@@ -0,0 +1,31 @@
+# Projects
+
+## Create New Project
+:::tip
+A `project` is a customer-owned entity. Therefore, the customer must exist prior to project creation.
+
+check here to [Create a Customer](/docs/administration/customers.md#create-new-customer)
+:::
+
+* Open Django Administration Panel
+* Under the project Section, you can see `Projects`, it will take you to the project list.
+* In the top right of the project list, you can see `ADD PROJECT` button. that will take you to new project form
+
+## New Project Form
+
+![Create Project Form](/adminstration/projects/new-project-form.png){data-zoomable}
+
+:::tip
+* `Name` & `Customer` are required fields
+:::
+
+
+## Assign a role to the user for the project
+
+In either the `Create New Project` or `Edit Project` form, there is a `PROJECT ASSIGNEES` section at the end.
+
+* click `Add another Project assignee` button
+* In the new form, you can select a user and define their role.
+![Project Assignee Form](/adminstration/projects/project-assignees.png){data-zoomable}
+* after that, click `Save` button in the end of the page
+

docs/administration/public-holidays.md

@@ -0,0 +1,18 @@
+# Public Holidays
+
+:::tip
+The public Holidays are defined for each location, which it will not calculate a negativ hours if there is no record in that date
+:::
+
+## Create New Public Holiday
+* go to [Django Admin Panel](/docs/administration/index.md#django-admin-panel)
+* under `EMPLOYMENT` section, you can find `Public Holidays`, which will take you to the list of public holidays
+* in the top right, you can find `ADD PUBLIC HOLIDAY` button.
+* to create new public holiday, you need to `Name`, `Date` and [Locations](/docs/administration/locations.md) field
+![Project Assignee Form](/adminstration/public-holidays/new-holiday-form.png){data-zoomable}
+
+:::tip
+* If the date have multi days, you have to create a holiday for each date.
+* If the Holiday is shared between multi locations, you have to create a record for each location
+:::
+

docs/administration/tasks.md

@@ -0,0 +1,36 @@
+# Tasks
+
+:::tip
+A `task` is a project-owned entity. Therefore, the [project](/docs/administration/projects.md) must exist prior to task creation.
+
+check here to [Create a Project](/docs/administration/projects.md#create-new-project)
+:::
+
+## Create new Task
+
+There are two locations that you can create a task with it
+
+* From Django admin panel
+* From the [Projects](/docs/projects.md) Page in the Timed software
+
+
+### Create a task from Django Admin
+* In the project section inside [Django Admin Panel](/docs/administration/index.md#django-admin-panel), you can see `projects`
+* Either you are creating new project or you are in editing project form, there is `TASKS` section
+![Project Task Form](/adminstration/tasks/tasks-form.png){data-zoomable}
+
+### Create a task from Timed side
+:::tip
+having the access to Timed app only, does not allow you to create new tasks in [Projects](/docs/projects.md) page, you should have `is manager` [role](/docs/administration/projects.md#assign-a-role-to-the-user-for-the-project) in the project.
+:::
+
+* Go to [Projects](/docs/projects.md) page
+* you will get a list of customers that you have `is manager` role in one of this customer projects.
+![Project Customers](/adminstration/tasks/timed-project-tasks.png){data-zoomable}
+* after selecting a customer, you can see the list of the selected customer projects
+![Project Tasks](/adminstration/tasks/timed-project-tasks.png){data-zoomable}
+* After selecting the project, you can see the list of the tasks that belongs to the selected project
+![Project Tasks List](/adminstration/tasks/project-tasks-list.png){data-zoomable}
+* or you can create new task by clicking `ADD TASK` button, and you will see the following form. (The `Name` field is required)
+![Project New Task Form](/adminstration/tasks/add-task-form.png){data-zoomable}
+

docs/administration/users.md

@@ -0,0 +1,13 @@
+# Users
+
+## Create New User
+There are lots of ways to create new users, and we're going to explain the differences between them one by one.
+
+## Create User Via Keycloak
+
+* Go to the admin area of your Keycloak, and select the realm that is configured with your timed.
+![Keycloak](/adminstration/users/keycloak.png){data-zoomable}
+
+* in the side menu, go to `Users`, and then click `Add user` button.
+![Users List](/adminstration/users/users-list.png){data-zoomable}
+

docs/index.md

@@ -4,6 +4,6 @@ Timed is a time tracking application built by [Adfinis](https://adfinis.com).
 
 The Adfinis internal instance can be accessed via [https://timed.adfinis.com](https://timed.adfinis.com)
 
-If you want to report an issue or request features, please [check the existing issues for similar or identical tickets](https://github.com/adfinis/timed-frontend/issues/) and if necessary create a new one.
+If you want to report an issue or request features, please [check the existing issues for similar or identical tickets](https://github.com/adfinis/timed/issues/) and if necessary create a new one.
 
 <!-- insert a overview of the app here and highlight the different parts you are going to describe in the further chapters. -->

docs/tracking/timesheet.md

@@ -1,5 +1,5 @@
 # Time Sheet
 
-![Time Sheet](/tracking/timesheet/timesheet.png)
+![Time Sheet](/tracking/timesheet/timesheet.png){data-zoomable}
 
 The generated daily report ends up in the _timesheet_ tab and shows the actual time spent at the end of the day. Reports can be edited until they are verified by your supervisor.

index.md

@@ -7,7 +7,7 @@ hero:
   text: "An Open Source Time Tracking App"
   tagline: "And easy to use time tracking app."
   image:
-    src: https://raw.githubusercontent.com/adfinis/timed-frontend/main/public/assets/logo.svg
+    src: https://raw.githubusercontent.com/adfinis/timed/main/frontend/public/assets/logo.svg
   actions:
     - theme: brand
       text: Documentation