@adminide-stack/clock-tik-browser 12.0.18-alpha.0 → 12.0.18-alpha.2

package/lib/templates/content/docs/csv-file-format.md

@@ -0,0 +1,87 @@
+---
+id: csv-file-format
+title: CSV file format
+sidebar_label: CSV file format
+---
+
+## Import clients & projects
+
+You can mass import projects, clients, tasks, and tags to Clockbook from a file. This feature is available on the free plan. Only admins can import data.
+
+If you have a paid subscription, you can also [import time entries.](./import-timesheets.md)
+
+## How to import data
+
+1. Go to Time Tracker > Import
+2. Click **Upload CSV** file and select file from your computer
+3. Review how many items will be created and click **Start import**
+4. When finished, you’ll get a confirmation message
+
+![img](/static/images/csv-import.png)
+
+## Required CSV format
+
+- Values need to be comma-separated
+- Columns must have headers in English. Values: Client, Project, Task, Tags
+- Maximum file size is 1 MB
+
+## CSV file example
+
+You can create a CSV file: By opening an Excel file and then go **Save as** and choose CSV format; or by opening a plain text editor (like Notepad) and putting headers in the first row (where you separate values with a comma), and listing values in new rows.
+
+**[Download example CSV file](/static/files/example_import_file.csv)**
+
+```
+ Project, Client, Task, Tags
+ ProjectA1,ClientA,,
+ ProjectB1,ClientB,,
+ ProjectB2,ClientB,TaskB1,
+ ProjectC1,,TaskC1,
+ ProjectC2,,TaskC1,Tag1
+ ,,,"Tag2,Tag3"
+
+```
+
+## Notes
+
+- File can have a single column or their combination (task column requires at least project column)
+- If you don’t group projects by Client, the column name must match what you’ve set in workspace settings (e.g. department, category…)
+- The order of the columns is not important. Names are case sensitive.
+- Multiple tags can be imported by surrounding tags in double quotes and separating with a comma (e.g. “tag1, tag2, tag3”)
+- If an item already exists, it will be skipped during the import. Only items that don’t already exist will be created.
+- When you upload a file, it will be first analyzed. If there’s an error, you’ll get a message and won’t be able to proceed.
+- You can import only projects, clients, or tags by creating a CSV file with a single column.
+- You can import projects and their respective client by including both columns.
+- If you import tasks, you need its project column.
+- Projects will inherit initial private/public and billable/non-billable status based on **New projects are by default** workspace settings.
+
+## Max character limits
+
+- Description: 3,000
+- Task: 1,000
+- Project: 250
+- Client: 100
+- Tag: 100
+
+## Importing multiple tasks
+
+You can import multiple tasks for the same project by including an additional line for the same project and specifying a different task.
+
+```
+    Project,Client,Task
+    ProjectA,ClientA,Task1
+    ProjectA,ClientA,Task2
+    ProjectA,ClientA,Task3
+```
+
+You can also add a task in bulk to existing projects:
+
+1. Go to Summary report
+2. Group by Project / (None)
+3. Select a long date range
+4. Export as CSV
+5. Open CSV in Excel or Google Sheets
+6. Delete time columns
+7. Add Task column and write new task name everywhere
+8. Save as CSV
+9. Import the new CSV file

package/lib/templates/content/docs/custom-fields.md

@@ -0,0 +1,118 @@
+---
+id: custom-fields
+title: Custom fields
+sidebar_label: Custom fields
+---
+
+Add additional fields to time entries and track anything!
+
+With custom fields, you can manually track: expenses, mileage, breaks, overtime, invoice status, number of units, custom dropdowns, quantity, codes, location, equipment, estimate, deal number, link to ticket, receipts, images, all sorts of IDs (invoice, task, user, project)… and more!
+
+In addition to user data, you can also track project metadata - perfect when you need to analyze data in pivot tables, or when you need to integrate Clockify with external systems via [API](# 'API').
+
+Custom fields are an extra feature, which you can enable by [upgrading](# 'upgrading') your workspace to Pro or Enterprise plan. You can try out the feature for free by activating the [free 7-day](# 'free 7-day') trial (no credit card required). If you use Custom fields during your trial, once the trial period ends all custom fields will disappear, however they will be activated as soon as you purchase the Pro or Enterprise plan, without losing any data.
+
+Users can enter data into custom fields via: web, browser extension, iOS, Android, and Mac (support for Windows coming soon).
+
+## Creating fields
+
+You can create custom fields in Workspace Settings > Custom Fields tab. You can have up to 50 fields in a workspace.
+
+When creating a field, you need to specify field type:
+
+- **Text** - input field where you can type anything you wish (project ID, additional notes, coordinates)
+- **Number** - input field that accepts only numerical values (mileage, expenses, number of units)
+- **Link** - input field that accepts URL to websites or files (receipts, screenshots, documents, task reference)
+- **Switch** - a simple yes/no switch (invoiced, paid, urgent)
+- **Select** - input field that lets users select a single option from a pre-determined list (location, status, category)
+- **Select** multiple - input field that lets users select any number of values from a pre-determined list (equipment used, custom tag list for a project)
+
+You can also prevent regular users from entering or changing data by settings "Who can edit: Admins" (for example, you can have Unpaid/Paid status which users can see but only admins can change).
+
+## Using fields
+
+In order for your users to see and use the fields you've created, drag-and-drop the field to the Visible slot in Active column. Then, the fields will show up in Time Tracker and Timesheet for everyone in the workspace.
+
+In Timesheet, you can enter data for additional fields when you hover over a cell with time and click on the three dots.
+
+You can have up to 5 visible fields for the whole workspace, plus 5 more on projects.
+
+Fields function like regular inputs, depending on the field type you've specified. Users can enter text, number, check a checkbox, or select from a list of predetermined values.
+
+**When to use invisible fields**
+
+Invisible fields are useful when you need to integrate Clockify with external systems via API, or you need entries to inherit additional metadata from projects (like project ID or project type) and you don't want to overburden your users with irrelevant data.
+
+If you activate a field and make it invisible, users won't see the field anywhere, but all created entries will have them. Entries can inherit value for invisible fields via project, or you can update them via API or some integration.
+
+Invisible fields and their data show up in Excel and CSV export of Detailed report.
+
+## Setting fields on projects
+
+In addition to activating custom fields for the whole workspace, you can also activate them by project instead, as well as override visibility and default value in project settings.
+
+All invisible fields automatically show up in projects. You can set their default value for that project, plus make them visible (or invisible) when a user selects that project.
+
+You can have up to 10 visible fields on a project.
+
+In addition to managing active fields, you can also add a field from a list of available fields, so only entries on that particular project have that field.
+
+If you wish fields to have some default value when a user selects a project. For example, if a user selects ProjectX, a field "Location" can be set to "USA", which the user can later override if it's not "USA".
+
+Be careful with default values as they always override existing values. For example, if a time entry has "My Value" and then you change a project with a "Default Value", it will overwrite "My Value" (you can re-enter "My Value", but if you change a time entry's project again, "My Value" will be lost).
+
+A project manager can override a field's visibility and set a default value for their projects.
+
+## Advanced usage
+
+You can achieve any workflow you need by using these four mechanisms:
+
+- **Editing permission** - You can let users edit data in a field for their time entries, or limit editing to admins only
+- **Visibility** - Affects whether users can see a field in Time Tracker and Timesheet
+- **Default value**- Fields on time entries start out as empty unless you prefill them with some default value
+- **Project overrides** - You can override a field's visibility and default value by project
+
+For example, you can set a field as non-editable by regular users and visible only on certain projects. Or, you can make some field invisible and set a default value on projects so each time entry has its project metadata.
+
+## Editing and deleting fields
+
+Activating a field doesn't impact older entries. Only new time entries going forward will have custom fields and default values. To retroactively add fields to time entries, you'll have to manually update the time entries.
+
+If you move a field from Active to Available, new entries will stop having that field, but existing entries will retain their data and show up in exports.
+
+Deleting a custom field deletes that field and all its data from all time entries, across the whole workspace. Once you delete a field, it's like it never existed. There is no undo. To retain data, it's best to deactivate it by moving the field to Available column.
+
+If you edit the options of a “Select” type field, existing time entries will retain the original values. Unless:
+
+- You manually change the value of “Select” type custom field on the time entry to a different value
+- You change the project of the time entry to a project which has a default value set for this "Select" type field. In this case, the entry will get the default value for the "Select" type custom field of the project you selected.
+
+### Editing example
+
+Let's say you have a “Select” type custom field named "Location" with 3 select options: "Los Angeles", "New York", and "Boston".
+
+You create a time entry and select "Los Angeles" as your location. Then you go to Workspace settings and rename "Los Angeles" option to "San Francisco".
+
+The created entry will retain the value "Los Angeles".
+
+If you edit the created entry and change its project to a project that has a default value for the Location field (e.g. New York) the entry will now have "New York" set as Location. In other words, default value will overwrite the original value any time you update an entry.
+
+Another example: let's say you create a field called "Updated", set default value "2020", and make it invisible. Your old entries won't have that field, but each entry moving forward will have it.
+
+If someone changes the project on their old entry, that entry will pick up the "2020" value even though it never had it, thus allowing you to see if some entry has been tampered with.
+
+## Custom fields in reports
+
+You can retrieve time entries with all their fields and data in Detailed Report via Excel and CSV export. Then, you can create all sorts of custom reports in pivot tables.
+
+You can see and edit the data for visible fields directly in the Detailed report. Additionally, admins can edit custom fields data other users have entered (regular members can only edit and delete time entries that belong to them).
+
+You can also use Bulk Edit to update Custom fields on multiple time entries with one click.
+
+Excel and CSV export list all active fields. If some entry has some value in some custom field that is no longer active in neither workspace nor some project, that field won't show up.
+
+[Download sample report (Excel)](# 'Download sample report (Excel)')
+
+The Reports also allows you to filter the report by custom fields. You can easily enable or disable what custom fields you'd like to see as filters and use them when filtering the time entries.
+
+These filters are user-specific. When you add some custom fields to filters, this doesn’t affect other users. Each user can have their own set of filters.

package/lib/templates/content/docs/customize-exports.md

@@ -0,0 +1,37 @@
+---
+id: customize-exports
+title: Customize exports
+sidebar_label: Customize exports
+---
+
+Groups make managing people on projects easier. Instead of adding people to project one by one, you can create a group and assign it to a project in one click.
+
+You can create, edit, and delete groups in the Groups tab of a Team page.
+
+To assign people to a group:
+
+1. Go to the Team page
+2. Open the Groups tab
+3. Click + Access under Access column next to the group's name
+4. Add people to the selected group
+
+You can remove a user from a group the same way as you added them.
+
+Clockbook has a special "Admins" group that can't be removed. People who are part of Admin group have total access to the whole workspace and its settings.
+
+## Assigning groups to projects
+
+Groups make managing people on projects easy. When people change teams or leave the company often, you don't have to go through each project and remove them - all you have to do is remove them from the group.
+
+You can add users to groups on the Team page, and then allocate the group to a project.
+
+To assign a group to a project:
+
+1. Go to a project
+2. Click Access tab
+3. Click + Add members
+4. Select the group
+
+Once you assign a group, everyone that belongs to that group will immediately have access to the project.
+
+You can filter reports by a group. For example, you can make a Developers group, and use the group as a filter to see only what your developers work on (and later, group the report by User to see the time breakdown for each developer). You can also simply group the Summary report by Group and see a breakdown for each group.

package/lib/templates/content/docs/deleting-account.md

@@ -0,0 +1,28 @@
+---
+id: deleting-account
+title: Deleting Account
+sidebar_label: Deleting Account
+---
+
+To delete your account:
+
+Go to https://clockbook.com/
+Let us know why you want to delete your account
+Type your password to confirm
+If you're the owner of the workspace and there are other users in your workspace, you won't able to delete your account until you either:
+
+Transfer your owner role to someone else
+Or remove all active team members from the workspace(s) where you are the owner
+Once you're not an owner of any workspace anymore, or once you're the only active member in workspace(s) where you are the owner, you can delete your account.
+
+## What happens with data
+
+Clockbook stores your data indefinitely until you delete your account.
+
+Once you confirm you want to delete your account:
+
+- Your account will be deleted immediately
+- All the workspaces (and data in them) where you are the owner will be deleted forever
+- Time entries you’ve made in someone else’s workspace won’t be deleted. They will be preserved under your name until the owner of that workspace deletes the workspace
+- Once you delete the account, there's no undo. If you’d like a backup of all your time entries, you can export them in the Detailed report
+- You won’t receive any more emails from us

package/lib/templates/content/docs/doc1.md

@@ -0,0 +1,206 @@
+---
+id: doc1
+title: Style Guide
+sidebar_label: Style Guide
+---
+
+You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Introduction
+
+This website contains our documentation.
+
+## Markdown Syntax
+
+To serve as an example page when styling markdown based Docusaurus sites.
+
+## Headers
+
+# H1 - Create the best documentation
+
+## H2 - Create the best documentation
+
+### H3 - Create the best documentation
+
+#### H4 - Create the best documentation
+
+##### H5 - Create the best documentation
+
+###### H6 - Create the best documentation
+
+---
+
+## Emphasis
+
+Emphasis, aka italics, with _asterisks_ or _underscores_.
+
+Strong emphasis, aka bold, with **asterisks** or **underscores**.
+
+Combined emphasis with **asterisks and _underscores_**.
+
+Strikethrough uses two tildes. ~~Scratch this.~~
+
+---
+
+## Lists
+
+1. First ordered list item
+1. Another item
+    - Unordered sub-list.
+1. Actual numbers don't matter, just that it's a number
+    1. Ordered sub-list
+1. And another item.
+
+- Unordered list can use asterisks
+
+* Or minuses
+
+- Or pluses
+
+---
+
+## Links
+
+[I'm an inline-style link](https://www.google.com/)
+
+[I'm an inline-style link with title](https://www.google.com/ "Google's Homepage")
+
+[I'm a reference-style link][arbitrary case-insensitive reference text]
+
+[You can use numbers for reference-style link definitions][1]
+
+Or leave it empty and use the [link text itself].
+
+URLs and URLs in angle brackets will automatically get turned into links. [http://www.example.com](http://www.example.com) or [http://www.example.com](http://www.example.com) and sometimes example.com (but not on GitHub, for example).
+
+Some text to show that the reference links can follow later.
+
+[arbitrary case-insensitive reference text]: https://www.mozilla.org/
+[1]: http://slashdot.org/
+[link text itself]: http://www.reddit.com/
+
+---
+
+## Images
+
+Here's our logo (hover to see the title text):
+
+Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1')
+
+Reference-style: ![alt text][logo]
+
+[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'
+
+Images from any folder can be used by providing path to file. Path should be relative to markdown file.
+
+![img](/static/img/logo.svg)
+
+---
+
+## Code
+
+```javascript
+var s = 'JavaScript syntax highlighting';
+alert(s);
+```
+
+```python
+s = "Python syntax highlighting"
+print(s)
+```
+
+```
+No language indicated, so no syntax highlighting.
+But let's throw in a <b>tag</b>.
+```
+
+```js {2}
+function highlightMe() {
+    console.log('This line can be highlighted!');
+}
+```
+
+---
+
+## Tables
+
+Colons can be used to align columns.
+
+| Tables        |      Are      |   Cool |
+| ------------- | :-----------: | -----: |
+| col 3 is      | right-aligned | \$1600 |
+| col 2 is      |   centered    |   \$12 |
+| zebra stripes |   are neat    |    \$1 |
+
+There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
+
+| Markdown | Less      | Pretty     |
+| -------- | --------- | ---------- |
+| _Still_  | `renders` | **nicely** |
+| 1        | 2         | 3          |
+
+---
+
+## Blockquotes
+
+> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
+
+Quote break.
+
+> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.
+
+---
+
+## Inline HTML
+
+<dl>
+  <dt>Definition list</dt>
+  <dd>Is something people use sometimes.</dd>
+
+  <dt>Markdown in HTML</dt>
+  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
+</dl>
+
+---
+
+## Line Breaks
+
+Here's a line for us to start with.
+
+This line is separated from the one above by two newlines, so it will be a _separate paragraph_.
+
+This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.
+
+---
+
+## Admonitions
+
+:::note
+
+This is a note
+
+:::
+
+:::tip
+
+This is a tip
+
+:::
+
+:::important
+
+This is important
+
+:::
+
+:::caution
+
+This is a caution
+
+:::
+
+:::warning
+
+This is a warning
+
+:::

package/lib/templates/content/docs/force-timer.md

@@ -0,0 +1,40 @@
+---
+id: force-timer
+title: Force timer
+sidebar_label: Force timer
+---
+
+Disable manual mode in Workspace Settings so users can't add time manually.
+
+While Force timer is enabled, users:
+
+- CAN create new entries using only timer (manual mode is disabled)
+- CAN add time entries via the [Auto Tracker](# 'Auto Tracker')
+- CAN delete existing entries (unless [locked](# 'locked') or [approved](# 'approved'))
+- CAN change entry's description, project/task, tag, and billable status (unless [locked](# 'locked') or [approved](# 'approved'))
+- CAN'T change start time of a running timer
+- CAN'T change start/end time and duration of an existing time entry
+- CAN'T duplicate an entry
+
+Restriction applies to all users, including Admins. Admins can't add time manually through the Time Tracker, but they can [add time for others](# 'add time for others') (including themselves) via the Detailed report.
+
+Team managers can add/edit time for their team members if enabled in Settings.
+
+Force timer is an extra feature, which you can enable by [upgrading](# 'upgrading') your workspace to Pro or Enterprise plan. You can try out the feature for free by activating the [free 7-day trial](# 'free 7-day trial') (no credit card required).
+
+## Assigning groups to projects
+
+Groups make managing people on projects easy. When people change teams or leave the company often, you don't have to go through each project and remove them - all you have to do is remove them from the group.
+
+You can add users to groups on the Team page, and then allocate the group to a project.
+
+To assign a group to a project:
+
+1. Go to a project
+2. Click Access tab
+3. Click + Add members
+4. Select the group
+
+Once you assign a group, everyone that belongs to that group will immediately have access to the project.
+
+You can filter reports by a group. For example, you can make a Developers group, and use the group as a filter to see only what your developers work on (and later, group the report by User to see the time breakdown for each developer). You can also simply group the Summary report by Group and see a breakdown for each group.

package/lib/templates/content/docs/formatting-project-note.md

@@ -0,0 +1,46 @@
+---
+id: formatting-project-note
+title: Formatting project note
+sidebar_label: Formatting project note
+---
+
+You can add additional information to projects by using project note. There you can write project brief, job codes, instructions, links to important documents, etc.
+
+Project note can hold as much information as you need (max 16,384 characters).
+
+Everyone who has access to the project can see project note. Only admins and project managers can edit it.
+
+Adding headings amd links
+You can format text in project note using markdown. So for example, if you wish to make a heading, you add # at the start of the row, like this ## Heading 2. Or, if you wish to bold some word, you need to surround the word with two asterisks, like this: `**bolded word**`.
+
+If you wish to add a link, you need to write it like this: `[linked word](url)`.
+
+If you want to import text from Word or Google Docs along with formatting, you can copy and paste it into some online Doc to Markdown converter, and paste the result into project note.
+
+`# Heading 1`
+
+`## Heading 2`
+
+`### Heading 3`
+
+`**bold**`
+
+`*italic*`
+
+`~strikethrough~`
+
+`[Link](https://clockbook.com/)`
+
+`inline code`'
+
+## `Horizontal rule:`
+
+`Bullet list:`
+`* apples`
+`* oranges`
+`* pears`
+
+`Numbered list:`
+`1. lather`
+`2. rinse`
+`3. repeat`