Add migrations setup doc #2183
No reviewers
Labels
No Label
dependencies
duplicate
help wanted
invalid
kind/bug
kind/feature
needs reproduction
question
security
wontfix
No Milestone
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: vikunja/vikunja#2183
Loading…
Reference in New Issue
No description provided.
Delete Branch "Elscrux/vikunja:docs/migration"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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.
@ -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.
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.
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:
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).
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.
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!
@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 :)
LGTM, thanks!