Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration copy writing improvements #515

Merged
merged 4 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We would ❤️ for you to contribute to Appwrite and help make it better! We wa

## How to Start?

If you are worried about or dont know where to start, check out the next section that explains what kind of help is needed and how you can get involved. You can reach out with any questions on our [Discord](https://appwrite.io/discord) server. You can also submit an issue and a maintainer can guide you!
If you are worried about or don't know where to start, check out the next section that explains what kind of help is needed and how you can get involved. You can reach out with any questions on our [Discord](https://appwrite.io/discord) server. You can also submit an issue and a maintainer can guide you!

## Repo Structure

Expand Down Expand Up @@ -242,7 +242,7 @@ When blogging, speaking about, or creating tutorials about one of Appwrite's man

### Presenting at Meetups

Presenting at meetups and conferences about your Appwrite projects is another excellent way to get the word out about Appwrite. Your unique challenges and successes in building things with Appwrite can provide great speaking material. Wed love to review your talk abstract/CFP, so get in touch with us if youd like some help!
Presenting at meetups and conferences about your Appwrite projects is another excellent way to get the word out about Appwrite. Your unique challenges and successes in building things with Appwrite can provide great speaking material. We'd love to review your talk abstract/CFP, so get in touch with us if you'd like some help!

### Sending Feedback & Reporting Bugs

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Console 2.0 is designed to be accessible, from design to code. Console 2.0 is al

### Scalability and Collaboration

The new console is more maintainable and welcoming to community contributions. Console 2.0 is built using Svelte instead of our own library. Its better documented and well-known, making it easier for developers to contribute to Appwrite.
The new console is more maintainable and welcoming to community contributions. Console 2.0 is built using Svelte instead of our own library. It's better documented and well-known, making it easier for developers to contribute to Appwrite.

## Contributing

Expand Down
12 changes: 11 additions & 1 deletion src/routes/console/(migration-wizard)/step2.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@
</script>

<WizardStep>
<svelte:fragment slot="title">Select data</svelte:fragment>
<svelte:fragment slot="title">Select resources</svelte:fragment>
<svelte:fragment slot="subtitle">
Select the resources you need to migrate to Appwrite. Some resources can be migrated, but
with limitations. <a
class="link"
href="https://appwrite.io/docs/migrations"
target="_blank"
rel="noopener noreferrer">
Learn about which resources are supported</a
>.
</svelte:fragment>
<ResourceForm {provider} {formData} projectSdk={getSdkForProject($selectedProject)} />
</WizardStep>
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
{:else if data.search}
<EmptySearch>
<div class="u-text-center">
<b>Sorry, we couldnt find ‘{data.search}</b>
<b>Sorry, we couldn't find ‘{data.search}'</b>
<p>There are no teams that match your search.</p>
</div>
<Button secondary href={`/console/project-${$page.params.project}/auth/teams`}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
{:else if data.search}
<EmptySearch>
<div class="u-text-center">
<b>Sorry, we couldnt find ‘{data.search}</b>
<b>Sorry, we couldn't find ‘{data.search}'</b>
<p>There are no members that match your search.</p>
</div>
<Button
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
</script>

<WizardStep>
<svelte:fragment slot="title">Create your function</svelte:fragment>
<svelte:fragment slot="subtitle">Let's create a function.</svelte:fragment>
<svelte:fragment slot="title">Configuration function</svelte:fragment>
<svelte:fragment slot="subtitle">Create your new Appwrite Function.</svelte:fragment>
<FormList>
<InputText
label="Name"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
</script>

<WizardStep>
<svelte:fragment slot="title">Execute access</svelte:fragment>
<svelte:fragment slot="title">Permissions</svelte:fragment>
<svelte:fragment slot="subtitle">
Choose who can execute this function using the client API. For more information, check out
the <a
Choose which users have permission to execute this function using Client SDKs. For more
information, check out the <a
href="https://appwrite.io/docs/permissions"
target="_blank"
rel="noopener noreferrer"
class="link">
Permissions guide
permissions documentation
</a>.
</svelte:fragment>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@
<WizardStep>
<svelte:fragment slot="title">Events</svelte:fragment>
<svelte:fragment slot="subtitle">
Set the events that will trigger your function. Maximum 100 events allowed.
Set the events that will trigger your function. Maximum 100 events allowed.<a
href="https://appwrite.io/docs/events"
target="_blank"
rel="noopener noreferrer"
class="link">
Learn more about events.
</a>.
</svelte:fragment>

{#if $createFunction?.events?.length}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,13 @@
<WizardStep>
<svelte:fragment slot="title">Variables</svelte:fragment>
<svelte:fragment slot="subtitle">
Create the environment variables or secret keys that will be passed to your function
Create the environment variables or secret keys that will be passed to your function. <a
href="https://appwrite.io/docs/permissions"
target="_blank"
rel="noopener noreferrer"
class="link">
permissions documentation
</a>.
</svelte:fragment>
{#if $createFunction.vars.length}
<Table noStyles>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,16 @@
</script>

<WizardStep>
<svelte:fragment slot="title">Choose provider</svelte:fragment>
<svelte:fragment slot="title">Select source</svelte:fragment>
<svelte:fragment slot="subtitle">
Select a source platform with the project you want to migrate. <a
class="link"
href="https://appwrite.io/docs/migrations"
target="_blank"
rel="noopener noreferrer">
Learn about which platforms are supported</a
>.
</svelte:fragment>
<div class="u-flex u-flex-vertical u-gap-8">
{#each Object.entries(providers) as [key, value]}
<label class="u-flex u-cross-center u-cursor-pointer u-gap-8">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@
</script>

<WizardStep>
<svelte:fragment slot="title">Select data</svelte:fragment>
<svelte:fragment slot="title">Select source</svelte:fragment>
<svelte:fragment slot="subtitle">
Select the resources you need to migrate to Appwrite. Some resources can be migrated, but
with limitations. <a
class="link"
href="https://appwrite.io/docs/migrations"
target="_blank"
rel="noopener noreferrer">
Learn about which resources are supported</a
>.
</svelte:fragment>
<ResourceForm {formData} {provider} projectSdk={sdk.forProject} />
</WizardStep>
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,15 @@

<CardGrid>
<Heading tag="h3" size="7">Import project data</Heading>
<p class="text">Import data from other products or from a different Appwrite instance</p>
<p class="text">
Import data from another platform or from a different Appwrite instance. <a
class="link"
href="https://appwrite.io/docs/migrations"
target="_blank"
rel="noopener noreferrer">
Learn about which platforms are supported</a
>.
</p>
<svelte:fragment slot="aside">
{#if data.migrations.length}
<div class="u-flex">
Expand Down Expand Up @@ -224,7 +232,14 @@
{#if isSelfHosted}
<CardGrid>
<Heading tag="h3" size="7">Deploy to Cloud</Heading>
<p class="text">Export data from your project to Appwrite Cloud</p>
<p class="text">
Export data from your project to Appwrite Cloud. <a
class="link"
href="https://appwrite.io/docs/migrations-local-to-cloud"
target="_blank"
rel="noopener noreferrer">
Learn more in our documentation.</a>
</p>
<svelte:fragment slot="aside">
<div class="import-box">
<div class="u-flex u-cross-center u-gap-8">
Expand All @@ -244,7 +259,14 @@
{:else}
<CardGrid>
<Heading tag="h3" size="7">Export to self-hosted instance</Heading>
<p class="text">Export data from your project to a self-hosted instance</p>
<p class="text">
Export data from your project to a self-hosted instance. <a
class="link"
href="https://appwrite.io/docs/migrations-cloud-to-local"
target="_blank"
rel="noopener noreferrer">
Learn more in our documentation.</a>
</p>
<svelte:fragment slot="aside">
<div class="import-box">
<div class="u-flex u-cross-center u-gap-8">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
{:else if data.search}
<EmptySearch>
<div class="u-text-center">
<b>Sorry, we couldnt find ‘{data.search}</b>
<b>Sorry, we couldn't find ‘{data.search}'</b>
<p>There are no files that match your search.</p>
</div>
<div class="u-flex u-gap-16">
Expand Down
Loading