From c07f7e8a7dfcbaf64387693a72284059f9eacd61 Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Sun, 9 Aug 2026 11:12:34 +0530 Subject: [PATCH 1/6] reducing repetition of 'things' to improve awkward sentence flow --- docs/entities-intro.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/entities-intro.rst b/docs/entities-intro.rst index 300d0e393..2f3e910c6 100644 --- a/docs/entities-intro.rst +++ b/docs/entities-intro.rst @@ -27,7 +27,7 @@ Concepts What are Entities? ------------------ -In the ODK context, an "Entity" can be thought of as a "thing". If your project involves things that need to be shared between forms and may change over time, you can represent them as Entities. You can use Entities to represent real things like trees, people, or cities. You can also represent more abstract things like tree visits, malaria cases, or city ratings as Entities. +In ODK, an **Entity** can be thought of as a “thing.” If your project involves items that need to be shared across forms and may change over time, you can represent them as Entities. Entities can represent real-world things such as trees, people, or cities. They can also represent more abstract concepts, such as tree visits, malaria cases, or city ratings. Entities are organized in lists that group together Entities of the same type. You can think of Entity Lists as spreadsheets or databases that are shared across forms. Forms can create, read, and update Entities. You can also think of Entities as the nouns (trees) and the forms as the verbs (Register a tree). From 435b5afcf62fc860e78f7bc4dac22efd92467ade Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Fri, 14 Aug 2026 18:14:36 +0530 Subject: [PATCH 2/6] docs: warning about s3 outage affecting downloads --- docs/central-install-digital-ocean.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/central-install-digital-ocean.rst b/docs/central-install-digital-ocean.rst index be0b4022d..78a242875 100644 --- a/docs/central-install-digital-ocean.rst +++ b/docs/central-install-digital-ocean.rst @@ -532,7 +532,11 @@ Creating and using a custom PostgreSQL database server Using S3-compatible Storage --------------------------- -By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. +By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. + +**Important**: If your S3-compatible storage is unavailable, Central can continue accepting submissions, but devices may not be able to download new forms or attachments stored there. + +If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. Consider the following to help you decide whether S3-compatible storage is a good fit: From ce9f59da0bbff648bc2589d401ef813400af010a Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Fri, 14 Aug 2026 18:24:40 +0530 Subject: [PATCH 3/6] docs: warning about s3 outage affecting downloads --- docs/entities-intro.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/entities-intro.rst b/docs/entities-intro.rst index 2f3e910c6..300d0e393 100644 --- a/docs/entities-intro.rst +++ b/docs/entities-intro.rst @@ -27,7 +27,7 @@ Concepts What are Entities? ------------------ -In ODK, an **Entity** can be thought of as a “thing.” If your project involves items that need to be shared across forms and may change over time, you can represent them as Entities. Entities can represent real-world things such as trees, people, or cities. They can also represent more abstract concepts, such as tree visits, malaria cases, or city ratings. +In the ODK context, an "Entity" can be thought of as a "thing". If your project involves things that need to be shared between forms and may change over time, you can represent them as Entities. You can use Entities to represent real things like trees, people, or cities. You can also represent more abstract things like tree visits, malaria cases, or city ratings as Entities. Entities are organized in lists that group together Entities of the same type. You can think of Entity Lists as spreadsheets or databases that are shared across forms. Forms can create, read, and update Entities. You can also think of Entities as the nouns (trees) and the forms as the verbs (Register a tree). From 861bc88af0d625c2ffa92972ae3a9d53a0aea3e6 Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Sat, 15 Aug 2026 09:34:19 +0530 Subject: [PATCH 4/6] docs: revise s3 outage warning --- docs/central-install-digital-ocean.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/central-install-digital-ocean.rst b/docs/central-install-digital-ocean.rst index 78a242875..b04c168d0 100644 --- a/docs/central-install-digital-ocean.rst +++ b/docs/central-install-digital-ocean.rst @@ -534,8 +534,8 @@ Using S3-compatible Storage By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. -**Important**: If your S3-compatible storage is unavailable, Central can continue accepting submissions, but devices may not be able to download new forms or attachments stored there. - +- If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. +- If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage. If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. Consider the following to help you decide whether S3-compatible storage is a good fit: From 2db51350a00f134abc00d566806e70ad94ebe894 Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Sun, 13 Sep 2026 20:38:17 +0530 Subject: [PATCH 5/6] docs: move S3 outage bullet into 'Consider the following' list --- docs/central-install-digital-ocean.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/central-install-digital-ocean.rst b/docs/central-install-digital-ocean.rst index 6269ca61c..5f06385ef 100644 --- a/docs/central-install-digital-ocean.rst +++ b/docs/central-install-digital-ocean.rst @@ -1,4 +1,4 @@ -.. spelling:word-list:: +5.. spelling:word-list:: Cloudflare .. _central-install-digital-ocean: @@ -532,17 +532,14 @@ Creating and using a custom PostgreSQL database server Using S3-compatible Storage --------------------------- -By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. - -- If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. -- If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage. -If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. +By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. Consider the following to help you decide whether S3-compatible storage is a good fit: * You can configure S3-compatible storage at any time and migrate existing files out of your database. However, once you opt into using S3-compatible storage, there is no automated way to migrate files back to the database. * If you opt into S3-compatible storage, any system you use to retrieve file data from Central must be able to follow redirects (for example, Briefcase will not be able to retrieve form and submission attachments but ``pyodk`` will). * The names of objects stored in S3-compatible storage do not stand alone and must be converted to useful filenames and connected to the right forms and/or submissions by Central. For example, object names will look like ``blob-412-950ababd4c8cf8d11rf5421433b5e3dafx5f6e75``. +* If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. * If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage. To use S3-compatible storage for all files saved in Central, follow these steps: From 0e5b0a6d724b3ea22c5ae13d995f2d313e2f692c Mon Sep 17 00:00:00 2001 From: Gaurav Goswami Date: Sun, 13 Sep 2026 20:45:44 +0530 Subject: [PATCH 6/6] docs: remove accidental character from spelling directive --- docs/central-install-digital-ocean.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/central-install-digital-ocean.rst b/docs/central-install-digital-ocean.rst index 5f06385ef..1c4945008 100644 --- a/docs/central-install-digital-ocean.rst +++ b/docs/central-install-digital-ocean.rst @@ -1,4 +1,4 @@ -5.. spelling:word-list:: +.. spelling:word-list:: Cloudflare .. _central-install-digital-ocean: