Add migrations setup doc #2183

Merged
konrad merged 5 commits from Elscrux/vikunja:docs/migration into main 2024-03-10 13:32:29 +00:00
Contributor

This should hopefully make the migration process for obvious, as discussed here https://community.vikunja.io/t/trello-import-issues/2110/7

Please note that I didn't test the new doc myself even though I made sure it followed markdown rules and is based on the existing doc files.

This should hopefully make the migration process for obvious, as discussed here https://community.vikunja.io/t/trello-import-issues/2110/7 Please note that I didn't test the new doc myself even though I made sure it followed markdown rules and is based on the existing doc files.
Elscrux added 1 commit 2024-03-10 12:01:26 +00:00
continuous-integration/drone/pr Build is passing Details
da683f1b5a
Add migrations setup doc
konrad reviewed 2024-03-10 12:09:57 +00:00
@ -0,0 +14,4 @@
There are several importers available for third-party services like Trello, Microsoft To Do or Todoist.
All available migration options can be found [here](https://kolaente.dev/vikunja/vikunja/src/branch/main/config.yml.sample#L218).
You can develop migrations for more services, see the [documentation](https://vikunja.io/docs/migrations/) for more info.
Owner

Please use a relative link for like this: {{< ref "./development/migration.md">}}

Please use a relative link for like this: `{{< ref "./development/migration.md">}}`
@ -0,0 +20,4 @@
## Trello
This guide is expecting that you're installing Vikunja via Docker Compose.
Owner

Please add a variant for non-docker installations.

Please add a variant for non-docker installations.
@ -0,0 +33,4 @@
- Set `key` to your [trello API key](https://trello.com/app-key)
- Replace `<frontend url>` in `redirecturl` with your url
```yml
migration:
Owner

Please either link from here to the config docs or vice-versa. I'd like to avoid having two places where the docs for this are placed, since we might need to update it in the future.

Please either link from here to the config docs or vice-versa. I'd like to avoid having two places where the docs for this are placed, since we might need to update it in the future.
@ -0,0 +65,4 @@
## Other third-party services
The import process for other third-party services might be different, but the setup should be similar to the other [setups](#setup).
Owner

I would remove this paragraph, right now it does not say anything. Perspectively, this document should priovide information for the other migrators as well, but that could happen in another PR.

I would remove this paragraph, right now it does not say anything. Perspectively, this document should priovide information for the other migrators as well, but that could happen in another PR.
Member

Hi Elscrux!

Thank you for creating a PR!

I've deployed the frontend changes of this PR on a preview environment under this URL: https://2183-docs-migration--vikunja-frontend-preview.netlify.app

You can use this url to view the changes live and test them out.
You will need to manually connect this to an api running somewhere. The easiest to use is https://try.vikunja.io/.

This preview does not contain any changes made to the api, only the frontend.

Have a nice day!

Beep boop, I'm a bot.

Hi Elscrux! Thank you for creating a PR! I've deployed the frontend changes of this PR on a preview environment under this URL: https://2183-docs-migration--vikunja-frontend-preview.netlify.app You can use this url to view the changes live and test them out. You will need to manually connect this to an api running somewhere. The easiest to use is https://try.vikunja.io/. This preview does not contain any changes made to the api, only the frontend. Have a nice day! > Beep boop, I'm a bot.
Elscrux added 4 commits 2024-03-10 12:33:54 +00:00
Author
Contributor

@konrad Done! I kept the parts about installation without Docker Compose vague as I didn't try it myself and just added a link. Let me know if this works :)

@konrad Done! I kept the parts about installation without Docker Compose vague as I didn't try it myself and just added a link. Let me know if this works :)
konrad approved these changes 2024-03-10 13:31:59 +00:00
Owner

LGTM, thanks!

LGTM, thanks!
konrad merged commit 1d5517b53a into main 2024-03-10 13:32:29 +00:00
konrad deleted branch docs/migration 2024-03-10 13:32:29 +00:00
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: vikunja/vikunja#2183
No description provided.