Skip to content

Commit

Permalink
docs: add migration guides
Browse files Browse the repository at this point in the history
  • Loading branch information
gabor-boros committed Oct 20, 2021
1 parent 649f873 commit aaebe2c
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
29 changes: 29 additions & 0 deletions www/docs/migrations/tempoit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Migrating from [Tempoit](https://sr.ht/%7Eswalladge/tempoit/).

## Recommended config

```toml
# Source config
source = "timewarrior"
source-user = "-"

# Timewarrior config
timewarrior-arguments = ["log"]
timewarrior-client-tag-regex = "^(oc)$"
timewarrior-project-tag-regex = "^(log)$"

# Target config
target = "tempo"
target-user = "<jira username>"

# Tempo config
tempo-url = "https://<org>.atlassian.net"
tempo-username = "<jira username>"
tempo-password = "<jira password>"

# General config
tags-as-tasks = true
tags-as-tasks-regex = '[A-Z]{2,7}-\d{1,6}'
round-to-closest-minute = true
force-billed-duration = true
```
34 changes: 34 additions & 0 deletions www/docs/migrations/toggl-tempo-worklog-transfer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Migrating from [Toggl to Jira worklog transfer](https://github.com/giovannicimolin/toggl-tempo-worklog-transfer).

!!! warning

To get your Toggl user ID, please check the [source documentation](https://gabor-boros.github.io/minutes/sources/toggl/)
of Toggl.

## Recommended config

```toml
# Source config
source = "toggl"
source-user = "<YOUR TOGGL USER ID>"

# Toggl config
toggl-api-key = "<YOUR API KEY>"
toggl-url = "https://api.track.toggl.com"
toggl-workspace = "<YOUR WORKSPACE ID>"

# Target config
target = "tempo"
target-user = "<jira username>"

# Tempo config
tempo-url = "https://<org>.atlassian.net"
tempo-username = "<jira username>"
tempo-password = "<jira password>"

# General config
tags-as-tasks = true
tags-as-tasks-regex = '[A-Z]{2,7}-\d{1,6}'
round-to-closest-minute = true
force-billed-duration = true
```
3 changes: 3 additions & 0 deletions www/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ nav:
- Toggl Track: sources/toggl.md
- Targets:
- targets/tempo.md
- Migrations:
- From "Tempoit": migrations/tempoit.md
- From "Toggl to Jira": migrations/toggl-tempo-worklog-transfer.md
- Contributing: CONTRIBUTING.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

0 comments on commit aaebe2c

Please sign in to comment.