From 8d78b42775e9a05c5adb2f19a0e1b3fbf07e0b35 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Wed, 25 Jan 2023 21:38:24 +0000 Subject: [PATCH 01/12] Add intro text --- app/views/docs/offline.phtml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index e69de29bb..547adf384 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -0,0 +1,19 @@ +

+ Appwrite Offline allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of WIFI range. Offline helps your app gracefully handle these real life situations and keep your users engaged. +

+ +

When Should I Enable Offline?

+

+ Appwrite Offline allows you to continue making requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again. +

+

+ You should consider enabling Offline if you expect the user device running your application to experience short periods without a network connection, like going on an airplane to going through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect you app to be offline for days or weeks at a time, you may also need to find alternative solutions. +

+ +

Tradeoffs of Enabling Offline

+

+ Offline support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection. +

+

+ When Offline is enabled, it will change how promises are resolved in the Appwrite SDKs. Requests made Offline can become blocking, which means you will need to change how you handle promises in your application. This means you may need to rewrite some of your code when adding Offline to existing applications. +

\ No newline at end of file From a46cc354cbc0ff88d2f9122486a6420e8b12ecdc Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:45:30 -0500 Subject: [PATCH 02/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index 547adf384..f80010c84 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -1,5 +1,5 @@

- Appwrite Offline allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of WIFI range. Offline helps your app gracefully handle these real life situations and keep your users engaged. + The Appwrite SDKs' Offline Support allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of Wi-Fi range. Offline Support helps your app gracefully handle these real-life situations and keeps your users engaged.

When Should I Enable Offline?

From a5cf410b799d18a436a21fc2d2a1fe0c88ebb28a Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:45:36 -0500 Subject: [PATCH 03/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index f80010c84..78fb35619 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -2,7 +2,7 @@ The Appwrite SDKs' Offline Support allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of Wi-Fi range. Offline Support helps your app gracefully handle these real-life situations and keeps your users engaged.

-

When Should I Enable Offline?

+

When Should I Enable Offline Support?

Appwrite Offline allows you to continue making requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again.

From 2cc25998695b7c6866fc02eb3cf2db5ae00c71e9 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:45:44 -0500 Subject: [PATCH 04/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index 78fb35619..d3b844af1 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -7,7 +7,7 @@ Appwrite Offline allows you to continue making requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again.

- You should consider enabling Offline if you expect the user device running your application to experience short periods without a network connection, like going on an airplane to going through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect you app to be offline for days or weeks at a time, you may also need to find alternative solutions. + You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions.

Tradeoffs of Enabling Offline

From 284eab43be8880016bbc1ba2943c2700f7c65d8e Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:46:00 -0500 Subject: [PATCH 05/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index d3b844af1..9d40cf1ed 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -4,7 +4,7 @@

When Should I Enable Offline Support?

- Appwrite Offline allows you to continue making requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again. + With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again.

You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions. From c84c16071a56f32ec3c27e6ebd56884d9f5077c9 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:46:07 -0500 Subject: [PATCH 06/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index 9d40cf1ed..01751ed20 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -10,7 +10,7 @@ You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions.

-

Tradeoffs of Enabling Offline

+

Tradeoffs of Enabling Offline Support

Offline support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection.

From 4894a138468c51898f1b14c5f6daaa7bce9850ce Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 17:46:13 -0500 Subject: [PATCH 07/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index 01751ed20..dd98bf41a 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -15,5 +15,5 @@ Offline support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection.

- When Offline is enabled, it will change how promises are resolved in the Appwrite SDKs. Requests made Offline can become blocking, which means you will need to change how you handle promises in your application. This means you may need to rewrite some of your code when adding Offline to existing applications. + When Offline Support is enabled, it will change how API calls are made in the Appwrite SDKs. Write requests made while offline will not return until online again, which means you will need to change how you call these methods in your application. This means you may need to rewrite some of your code when adding Offline Support to existing applications.

\ No newline at end of file From 69e5c823d0c2c07622c6476d1dba8e21f02dd2c7 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 26 Jan 2023 22:53:22 +0000 Subject: [PATCH 08/12] Rewrite trade offs + existing projects --- app/views/docs/offline.phtml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index dd98bf41a..fba136423 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -2,7 +2,7 @@ The Appwrite SDKs' Offline Support allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of Wi-Fi range. Offline Support helps your app gracefully handle these real-life situations and keeps your users engaged.

-

When Should I Enable Offline Support?

+

When Should I Enable Offline Support?

With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again.

@@ -10,10 +10,11 @@ You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions.

-

Tradeoffs of Enabling Offline Support

+

Considerations and Tradeoffs

- Offline support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection. + Offline Support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection.

+

Offline Support for Existing Projects

- When Offline Support is enabled, it will change how API calls are made in the Appwrite SDKs. Write requests made while offline will not return until online again, which means you will need to change how you call these methods in your application. This means you may need to rewrite some of your code when adding Offline Support to existing applications. + Promises may not resolve immediately when Offline Support is enabled. Existing projects will require some code to be rewritten when adopting Offline Support. Learn more about promise resolution.

\ No newline at end of file From ae66a2ba4af2bd8d006eaf4e4ffbb51b2b022f91 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Mon, 6 Feb 2023 11:05:40 -0500 Subject: [PATCH 09/12] Update app/views/docs/offline.phtml Co-authored-by: Bradley Schofield --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index fba136423..c072e2f44 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -7,7 +7,7 @@ With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again.

- You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions. + You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline Support can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions.

Considerations and Tradeoffs

From 7ca33c46ba181bc79ac58890706f5d8ff0860d5e Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Mon, 6 Feb 2023 12:03:53 -0500 Subject: [PATCH 10/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index c072e2f44..37d099efb 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -16,5 +16,5 @@

Offline Support for Existing Projects

- Promises may not resolve immediately when Offline Support is enabled. Existing projects will require some code to be rewritten when adopting Offline Support. Learn more about promise resolution. + Asynchronous operations may not resolve immediately when Offline Support is enabled. Existing projects will require some code to be rewritten when adopting Offline Support. Learn more about how to handle asynchronous operation.

\ No newline at end of file From 8c0b39e89d9514590975fa3eef637a839592b433 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 10 Feb 2023 13:26:23 -0500 Subject: [PATCH 11/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index 37d099efb..aba188cef 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -4,7 +4,7 @@

When Should I Enable Offline Support?

- With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again. + With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cached data, and write requests will be queued and executed once the device is online again.

You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline Support can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions. From 5828b058e7a9fe2814b87101579ec8b0635ef054 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 10 Feb 2023 13:26:38 -0500 Subject: [PATCH 12/12] Update app/views/docs/offline.phtml Co-authored-by: Steven <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/offline.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/offline.phtml b/app/views/docs/offline.phtml index aba188cef..8fd3a603f 100644 --- a/app/views/docs/offline.phtml +++ b/app/views/docs/offline.phtml @@ -7,7 +7,7 @@ With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cached data, and write requests will be queued and executed once the device is online again.

- You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline Support can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions. + You should consider enabling Offline Support if you expect the device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline Support can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions.

Considerations and Tradeoffs