Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Add migration docs #399

Merged
merged 48 commits into from
Aug 25, 2023
Merged

Add migration docs #399

merged 48 commits into from
Aug 25, 2023

Conversation

gewenyu99
Copy link
Contributor

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)


<h2><a href="#limitations" id="limitations">Limitations</a></h2>
<p>
[TODO] @bradley help me out here. include performance, feature, all things annoying
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -0,0 +1,3 @@
<p>
[TODO: Bradley try to fill this in with necessary information + limitations]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PineappleIOnic

This document should contain everything a user needs to know about migrating from Firebase to Appwrite, don't worry about looking pretty, get the information down first, we'll edit this and use flow as template for other providers

@gewenyu99 gewenyu99 changed the base branch from main to 1.4.x August 15, 2023 17:35
@gewenyu99 gewenyu99 marked this pull request as ready for review August 15, 2023 17:35
@gewenyu99
Copy link
Contributor Author

localhost_2080_docs_migrations (6)
localhost_2080_docs_migrations (7)
localhost_2080_docs_migrations (8)
localhost_2080_docs_migrations (9)
localhost_2080_docs_migrations (10)
localhost_2080_docs_migrations (11)

@eldadfux
Copy link
Member

  • Let's not use the ✅ emoji. We can either use a simple text or one of the icons that we have in the icons library.
  • Let's add a disclaimer, that while this can be a good starting point and a good shortcut, when you try to migrate complex databases you most likely need to invest extra time in setting permissions and validating your data structure.
  • Opening the overview page with a question, sounds a bit off our voice in the docs.
  • We can skip images for the providers in these pages.
  • The supported sources table seems a bit off. Maybe we can just have a bullet-list? We can also try to have one big support table with links to the different tutorials.

@gewenyu99 gewenyu99 requested a review from eldadfux August 22, 2023 14:29
<li>Appwrite will not incur usage charges during migrations, but Firebase may still incur service charges.</li>
<li>Appwrite Migrations only supports Firestore as a database source. Realtime Database is <b>currently not supported</b>.</li>
<li>At the moment only top level document migration is supported. Nested documents will not be transferred automatically.</li>
<li>OAuth users will not be transferred. Users will need to re-authenticate with your OAuth provider after the migration is complete.</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also mention that Functions will not be transferred, and that developer needs to rewrite functions to use Appwrite syntax

Click on the <b>Create Migration</b> button and select <b>Firebase</b> as your source.
</li>
<li>
Depending on where your Appwrite project is hosted, you'll need to use different methods to authorize with Firebase.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's always manual way. @PineappleIOnic can confirm

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we had an service account.

discover your Firebase projects. Simply select the source project and follow the migration wizard.
</p>

<p>After completing the migration wizard, migration will begin. Return to step 4 of <a href="#migration-process">the migration steps</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cant see any step 4 in this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll see it when it's rendered

Upload the JSON file to Appwrite and follow the migration wizard.
</li>
<li>
After completing the migration wizard, migration will begin. Return to step 4 of <a href="#migration-process">the migration steps</a>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cant see step 4 in this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll see it when it's rendered

Copy link
Contributor

@Meldiron Meldiron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once my comments are addressed, this looks good to me. Feel free to only apply what makes sense to you too

Vincent (Wen Yu) Ge and others added 19 commits August 25, 2023 10:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants