From 7a463eebdc92465dd207ab7d0095db499e639294 Mon Sep 17 00:00:00 2001 From: acaptutorials Date: Fri, 27 Dec 2024 23:53:00 +0800 Subject: [PATCH] docs: note on-going development to address inconsistent excel templates --- .../pages/post-installation/cropping-calendar/calendar-v2.mdx | 4 ++-- .../post-installation/recommendations/recommendations-v2.mdx | 4 ++-- docs/pages/security.mdx | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx b/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx index edd64bd6..b44ec57f 100644 --- a/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx +++ b/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx @@ -93,11 +93,11 @@ The **crop stage codes** should match those defined in the [ACAP 2.0 crop recomm Update the frontend and backend codes with necessary data for supporting other crops, with data formats described in the [Data Format](#data-format) and [Crop Stage Codes and Labels](#crop-stage-codes-and-labels) section. -**Overwrite** and **commit** the sample cropping calendar Excel template files **`rice_cropping_calendar.xlsx`** and **`corn_cropping_calendar.xlsx`** in the **server** directory with the **regional cropping calendar files** to change the default sample Excel templates during live deployment. +**Overwrite** and **commit** the sample cropping calendar Excel template files **`rice_cropping_calendar.xlsx`** and **`corn_cropping_calendar.xlsx`** in the **server** directory with the correct **regional cropping calendar files** to change the default sample Excel templates during live deployment. Also, change the values of the environment variables (`CROPPING_CALENDAR_RICE_EXCEL_FILE`, `CROPPING_CALENDAR_CORN_EXCEL_FILE`) associated with its file names in the **client** `.env` file and **GitHub Secrets** if there is a need to use different file names or add new templates. -> **NOTE**: This step is only compatible until @commit **ee49568** (pre-ACAP 2.1) in the **acap-v2 dev** branch. Kindly chat the ACAP group chat for more information about the new Cropping Calendar Excel file format and management for ACAP 2.1 if it's missing in the online documentation. +> **NOTE:** This step is compatible until @commit **95a97cd** (latest updates) in the **acap-v2 dev** branch. However, the default cropping calendar Excel templates inside the repository only work until the previous updates @commit **ee49568** (pre-ACAP 2.1). Kindly chat the ACAP group chat for more information about the new Cropping Calendar Excel file format and management for ACAP 2.1 if it's missing in the online documentation. ### Login as Admin diff --git a/docs/pages/post-installation/recommendations/recommendations-v2.mdx b/docs/pages/post-installation/recommendations/recommendations-v2.mdx index 299dcfca..6d02c08a 100644 --- a/docs/pages/post-installation/recommendations/recommendations-v2.mdx +++ b/docs/pages/post-installation/recommendations/recommendations-v2.mdx @@ -63,11 +63,11 @@ The **crop stage labels** should match the **crop stage codes** defined in the [ Update the frontend and backend codes with necessary data for supporting other crops, with data formats described in the [Data Format](#data-format) section. -**Overwrite** and **commit** the sample cropping calendar Excel template files **`rice_recommendations_v4.xlsx`** and **`corn_recommendations_v3.xlsx`** in the **server** directory with the **regional recommendation files** to change the default sample Excel templates during live deployment. +**Overwrite** and **commit** the sample cropping calendar Excel template files **`rice_recommendations_v4.xlsx`** and **`corn_recommendations_v3.xlsx`** in the **server** directory with the correct **regional recommendation files** to change the default sample Excel templates during live deployment. Also, change the values of the environment variables (`RECOMMENDATIONS_RICE_EXCEL_FILE`, `RECOMMENDATIONS_CORN_EXCEL_FILE`) associated with its file names in the **client** `.env` file and **GitHub Secrets** if there is a need to use different file names or add new templates. -> **NOTE:** This step is only compatible until @commit **ee49568** (pre-ACAP 2.1) in the **acap-v2 dev** branch. Kindly chat the ACAP group chat for more information about the new Crop Recommendations Excel file format and management for ACAP 2.1 if it's missing in the online documentation. +> **NOTE:** This step is compatible until @commit **95a97cd** (latest updates) in the **acap-v2 dev** branch. However, the default crop recommendations Excel templates inside the repository only work until the previous updates @commit **ee49568** (pre-ACAP 2.1). Kindly chat the ACAP group chat for more information about the new Crop Recommendations Excel file format and management for ACAP 2.1 if it's missing in the online documentation. ### Login as Admin diff --git a/docs/pages/security.mdx b/docs/pages/security.mdx index b3b7ec11..6d793b20 100644 --- a/docs/pages/security.mdx +++ b/docs/pages/security.mdx @@ -53,7 +53,7 @@ Manually test and ensure, using the Firebase Storage Web APIs, that: ## Codebase -- Ensure that forked **climate-services-webportal-v1** (ACAP 1.0) or **acap-v2** (ACAP 2.0) monorepo code base or copies remain PRIVATE in GitHub. +- Ensure that forked **climate-services-webportal-v1** (ACAP 1.0) or **acap-v2** (ACAP 2.0) monorepo code base or copies remain PRIVATE in GitHub and other public platforms.