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

package/lib/templates/content/docs/managing-people-on-projects.md

@@ -0,0 +1,79 @@
+---
+id: managing-people-projects
+title: Managing people on projects
+sidebar_label: Managing people on projects
+---
+
+## Project privacy settings
+
+There are two types of projects – Public and Private. When you create a project, you can choose whether it'll be Private or Public (default option).
+
+You can change the default option for project's privacy in the Workspace settings.
+
+**Public projects** are:
+
+- Accessible to all workspace users
+- Everyone can select the project when tracking time
+- Everyone can see all time entries for that project in reports
+
+**Private projects** are:
+
+- Only accessible to project members
+- Only project members can select the project when tracking time
+- Members can only see their own tracked time in reports (if Hide time from users is enabled)
+- Only project managers can see all tracked time on their project in reports if Hide time from users is enabled
+
+Once you create a project, you can always change its visibility by selecting Public or Private in the project's Access tab.
+
+Only Admins and Project Managers can change visibility after a project is created.
+
+Admins can see and edit all projects and time entries, no matter if the project is public or private.
+
+By default, only admins can create projects but you can allow regular users to create projects and clients when you set Who can create projects and clients to Everyone in your Workspace settings.
+
+## Adding people to projects
+
+To invite people and groups on a project:
+
+1. Click on a project
+2. Go to the Access tab
+3. Click "+ Add members"
+4. Select people or groups you want to add to the project
+
+People will automatically get access to the project once you add them (meaning, there's no project invite).
+
+Once people are added to the project, they can select the project when tracking time.
+
+Only people who are invited to your workspace can be invited to a project.
+
+## Removing people from projects
+
+To remove a user from a project, go to the Access tab of the project, click the three little dots near the user's name and then click "Remove".
+
+## Set a billable rate for people on the project
+
+If you want to assign a different billable rate for each person on some particular project, go to the Projects page, click on the name of the project you want, switch to the Access tab and then define the billable rate for the users in the project.
+
+## Project roles
+
+The user who creates a project automatically gets the Manager role on that project. A project can have more than one manager.
+
+To give someone manager rights, go to the project's Access tab, click three dots next to the person's name, and select Give manager rights. To revoke manager role, click three dots next to the person's name and select Revoke manager rights.
+
+**Admins** can see and edit everything, at all times.
+
+**Regular** users can:
+
+- See and edit all information regarding tasks (unless disabled)
+- See who has access to the project (can't edit)
+- See rates if "Who can see rates and amounts" is set to Everyone
+
+Project managers can:
+
+- See and edit project details
+- See and edit all information regarding tasks on their projects even if task creation is allowed to admins only
+- See and edit project access
+- See and edit rates if "Who can see rates and amounts" is set to Everyone
+- View project status for projects they manage
+- Delete project
+- See all tracked time for their projects in reports

package/lib/templates/content/docs/managing-projects.md

@@ -0,0 +1,163 @@
+---
+id: managing-projects
+title: Managing projects and clients
+sidebar_label: Managing projects and clients
+---
+
+## Managing projects and clients
+
+Projects are useful for grouping and categorizing time entries that belong to the same type of work. Projects make it easier to analyze data, generate more useful reports, and see where and how you spend time.
+
+Each project typically belongs to some client, but you can create a project without a client (e.g. internal company stuff). A client can have many projects, but a project can belong to only one client.
+
+You can also import projects and clients from a file.
+
+### Creating a project on the Project page
+
+By default, only admins can create projects but you can allow regular users to create projects and clients when you set Who can create projects and clients to Everyone in your Workspace settings.
+
+To create a project:
+
+1. Go to Projects and click "Create new project"
+2. Name the project
+3. Select client (you can also create a new client here, by typing a name and clicking "Create client")
+4. Choose a project color
+5. Choose visibility (public or private)
+6. Click "Create"
+
+Once you've created a project, you can select it when tracking time. If you've set the project as private (visible only to a certain group), then only people who are on the project will be able to select it when tracking time.
+
+### Creating a project on the Time Tracker page
+
+You can also add a project directly from the Time Tracker page while creating a new time entry.
+
+Click on the "+Project" field to get a drop-down list of projects and start typing the name of your new project. Once you start typing the drop-down list will try to suggest a matching (existing) project name.
+
+If that project does not exist you will be offered the option to create a new project.
+
+You can either:
+
+Click on the "+ Create new project" button and a popup window with additional options will appear allowing you to name your project, assign a client, apply a project template and select if the project will be public or private.
+or
+
+Use a keyboard shortcut Ctrl+Enter to quickly create a project without additional details
+
+### Archiving projects
+
+Once you complete a project, you can archive it, so it's no longer visible when tracking time.
+
+To archive a project:
+
+1. Go to the Projects page
+2. Click three dots next to the project you want to archive
+3. Select Archive
+
+To see archived projects, click the Active filter at the top of the page and change it to Archived. Once the project is archived you will be able to delete it.
+
+To restore an archived project, click three dots next to it and select Restore.
+
+When you archive a project:
+
+- All its data is still available
+- Project's time entries will still be shown in reports
+- Archived projects won't appear in reports as filters unless you select Active&Archived or Archived
+- Archived project won't be available when tracking time
+- sArchived projects won't appear on Projects page (unless you select Archived in the filter)
+
+You can also archive tags and clients the same way you can archive projects.
+
+### Deleting projects
+
+Projects can only be deleted once they are archived.
+
+To delete a project:
+
+1. Go to Projects page
+2. Select Show archived or Show all from the drop-down menu
+3. Click three dots next to the archived project's name
+4. Select Delete
+5. Confirm the action
+
+### Merging Projects
+
+While it's not possible to merge projects, you can filter entries of one of the projects you want to merge and assign it to the other project in the Detailed report.
+
+It is also possible to update multiple time entries at the same time with the Bulk edit feature in the Detailed report.
+
+Then, simply archive and delete the project you don't need.
+
+### Managing people on projects
+
+To see how to change the project's privacy settings, manage user access to a project, or set users as project managers, visit this help article.
+
+### Project Status
+
+When you and your team start tracking time for projects and tasks, you'll be able to track progress on each project using Project status.
+
+To learn more about how to use project status, visit this help article.
+
+### Project Note
+
+You can add additional information to projects by using a project note. To learn more about how to format a project note, visit this help article.
+
+### Set a billable rate for the Project
+
+Clockbook has 4 types of billable rates, one of which is the project billable rate. If set, this billable rate gets applied to each time entry created for this project.
+
+The project billable rate can be overwritten by Projects’ member rate which you define in the projects’ Access tab if you want different users on the project to have different billable rates.
+
+**To set a billable rate for a specific project:**
+
+1. Go to the Projects page
+2. Click on the name of the specific project
+3. Switch to Project settings tab
+4. Set billable rate for the project
+
+**To set different pricing per client at the project level:**
+
+1. Create different projects
+   . Assign them to respective clients
+   . Go to Projects and click the project name (which will bring you to Project edit page)
+   . Switch to Project Settings tab
+   . Set the desired billable rate for the project.
+   . Repeat for each project for the specific client
+
+### Filtering and sorting projects
+
+When you have a lot of projects, it can be difficult finding what you need. That's when filters come in handy.
+
+You can filter projects by their active status, client, users who are part of it, billability, and name.
+
+You can sort projects alphabetically by clicking "Name" on the header of the project table. It is possible to sort projects by Client and Status as well.
+
+### Creating projects from a template
+
+If you have a lot of similar projects, it's a good idea to set up a template so you don't have to create the same project over and over.
+
+Projects you create with an existing template will have settings such as Billable Rates, Estimates, Tasks and Team already applied.
+
+Project templates are an extra feature, which you can enable once you upgrade your account.
+
+## Managing clients
+
+Owners and admins can see the Clients page, but regular users can't. However, if the owner or admin sets "Who can create projects and clients" to Everyone in the Workspace settings, regular users will be able to create clients when they create a new project by typing the new client name in the client selection drop-down (even though they still won't be able to see the Clients page.)
+
+### How owners and admins can create clients
+
+If you're the owner or an admin of the workspace, to create a client simply:
+
+1. Go to Clients page from sidebar
+2. Enter the client's name in the "Add new client" field
+3. Click Add
+
+### How regular users can create clients
+
+If you want regular users to be able to add clients:
+
+1. Admin or owner needs to set "Who can create projects and clients" to Everyone
+2. A regular user can then go to the Projects page to create a project
+3. Click "Select client"
+4. Enter client name
+5. Click "Create client" or press Ctrl+Enter
+
+If you want to create a client only, simply create the client with the mentioned steps above and cancel the project creation.

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

@@ -0,0 +1,17 @@
+---
+id: mdx
+title: Powered by MDX
+---
+
+You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/).
+
+export const Highlight = ({children, color}) => ( <span style={{
+      backgroundColor: color,
+      borderRadius: '2px',
+      color: '#fff',
+      padding: '0.2rem',
+    }}>{children}</span> );
+
+<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.
+
+I can write **Markdown** alongside my _JSX_!

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

@@ -0,0 +1,51 @@
+---
+id: paypalsetup
+title: PayPal Payroll Setup
+sidebar_label: Paypal Setup
+---
+
+![img](/static/img/paypal_header.png)
+
+Clockbook supports automatic and manual payments through [Paypal](https://www.paypal.com/).
+
+This guide is for organization owners looking to connect their PayPal accounts to pay their team. If you are a user and want to connect your PayPal account to get paid, please see this guide.
+
+- PayPal
+- PayPal Classic
+- Upgrading to the new PayPal Payroll
+
+## PayPal
+
+Follow the steps below to set up your PayPal payroll account:
+
+## Required steps before setting up:
+
+- Ensure the PayPal account is set up as a business account and that payouts are activated.
+- Fund account (it cannot pull funds from a bank account or credit card).
+- USD funds are needed in the PayPal balance.
+
+## Requesting PayPal Payouts Activation
+
+For a list of supported countries click here.
+
+- Navigate to [https://www.paypal-support.com/](https://www.paypal-support.com/).
+- Click the Contact Us button.
+  ![img](/static/img/paypal_contact_us.png)
+- Log in to your PayPal (Portal) account. If you don’t have a portal account you can click on “Log in with PayPal” to activate your portal account.
+- Fill in these details on the questionnaire, then hit the Submit button.
+
+![img](/static/img/submit_question_paypal_payouts.png)
+
+## Using Paypal Payroll
+
+If you’re still using the PayPal Classic integration, you will receive a notification asking you to upgrade your current PayPal integration.
+
+Benefits of upgrading:
+
+- The new integration no longer requires have Mass Payments to be enabled before you can make payments.
+- The new integration will have a more seamless connection to Clockbook.
+- It enables you to receive accurate payment statuses from PayPal.
+- The Classic integration will eventually be retired by PayPal.
+- For frequently asked questions regarding our payroll feature, please refer here.
+- If you pay your team members through Clockbook via one of our payroll options (Payoneer, PayPal, TransferWise, or Bitwage), there are no fees charged by Clockbook (we don’t take any percentage of the payments). The only fees are the nominal fees charged by the payment sites.
+- If you choose Bi-weekly payments, you will have the option to choose between two start on dates (pay periods).

package/lib/templates/content/docs/profile-settings.md

@@ -0,0 +1,21 @@
+---
+id: profile-settings
+title: Profile Settings
+sidebar_label: Profile Settings
+---
+
+Each user can set their preferences in Profile settings. Profile settings are applied on a per-user basis. If you change something, it won't affect other users, only you.
+
+You can access Profile settings by clicking on your profile in the upper right corner.
+
+In Profile settings, you can:
+
+- Upload and remove your profile picture
+- Change name and email
+- Change password - you can create a password using small and big letters, upper and lower cases, numbers, the only limitation is that it needs to be a minimum of 6 or a maximum of 50 characters
+- Enable or disable grouping of similar time entries
+- Make project list compact
+- Activate or deactivate the task filter
+- Control what emails you get from Clockbook (newsletter, personal weekly report, and long-running timers)
+- Change time settings (time zone, date format, time format, week start, and day start)
+- Get your API key and create webhooks

package/lib/templates/content/docs/project-filter.md

@@ -0,0 +1,37 @@
+---
+id: project-filter
+title: Quickly finding projects/tasks
+sidebar_label: Quickly finding projects/tasks
+---
+
+## Compact project list
+
+If you have hundreds of clients, projects, and tasks, and have trouble finding the right one when tracking time, you might want to enable compact project list in your Personal Settings.
+
+Compact project list collapses all projects under its client, making the list more manageable.
+
+If your projects/clients have long name, you can expand the list across the whole screen.
+
+## Project and task favorites
+
+If there are some projects and tasks you're using often, you can mark them as favorite so they appear at the top of the project finder.
+
+To use the Project favorites you will need to enable them in the Workspace settings first. To do this switch the toggle under Project favorites to "Activate project favorites".
+
+You can mark a project as a favorite in the Projects page by clicking on the star next to it, or directly in the project finder.
+
+Favorite projects are user specific. When you mark some project as a favorite, this doesn't affect other users. Each user can have his or her own set of favorite projects.
+
+## Task filter
+
+If you prefer to filter primarily by project or client, keep the task filter off and the filter will take into account:
+
+- Project name
+- Client name
+
+However, if you use a lot of tasks when tracking time, you might want to activate the Task filter. This filter is user-specific so each user can activate it in the Profile settings (inside the web app).
+
+Once it's selected, you can quickly find the task (and project and client) you're looking for by using "task @project" syntax:
+
+1. Enter task name to find the task you need
+2. Further filter the results by adding @ prefix and typing project or client name

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

@@ -0,0 +1,49 @@
+---
+id: project-templates
+title: Project templates
+sidebar_label: Project templates
+---
+
+If you continuously work on similar projects, it's a good idea to set up a Project Template so you don't have to bother creating the same project over and over. Projects you create with an existing Template will have settings such as Billable Rates, Estimates, Tasks, Team, and [Custom Fields](# 'Custom Fields') already applied.
+
+Project templates is an extra feature, which you can enable by [upgrading](# 'upgrading') your workspace to any of the paid plans. You can try out the feature for free by activating the [free 7-day trial](# 'free 7-day trial') (no credit card required).
+
+## Creating a template
+
+Here's how you can set up a Project as Template:
+
+1. Go to your Projects Page
+2. Click on the three little dots near the Project's name
+3. Select “Set as template”
+
+You can set up an unlimited number of templates.
+
+**Note:** If a user on a templated project doesn't have an account yet, they won't have access to projects made from the template.
+
+## Creating a project from a template
+
+Now that you've set up a Project Template, you can use it when creating new projects.
+
+1. Go to your Projects Page
+2. Click the “Create new project” button in the upper-right corner
+3. Click the “No Template” field
+4. Choose your Template from the drop-down
+5. Click Create
+
+## Removing template
+
+If you no longer want a certain project to serve as a template, you can easily remove it as a template.
+
+1. Go to your Projects Page
+2. Click on the three little dots near the Project's name
+3. Select “Don't use as template”
+
+If you archive a certain project that serves as a template, that's okay, it will still be offered as a template until you manually remove it as a template.
+
+## Changing a template
+
+If you change a project that was saved as a template, projects created based on that template will not be changed.
+
+Only new projects created from the changed template will reflect the changes.
+
+If you allow regular users to create projects, they can choose any templates no matter the template's project privacy status. But, regular users can't create new templates or delete existing ones.