diff --git a/docs/pages/changelog.mdx b/docs/pages/changelog.mdx index 5ec54bc6..972ee25e 100644 --- a/docs/pages/changelog.mdx +++ b/docs/pages/changelog.mdx @@ -46,12 +46,12 @@ This page contains summary of features and enhancements on major ACAP versions a ### Version 2 (ACAP 2.0) -_June 2024 - ongoing_ +_June 2024 - December 2024_ -Version 2.0 highlights ongoing improvements and newly added features, expanding and enhancing the initial [ACAP](#version-1-acap-10) version. +Versions from 2.0+ highlight ongoing improvements and newly added features, expanding and enhancing the initial [ACAP](#version-1-acap-10) version. -ACAP 2.0 is the latest ACAP version. It's latest stable version is Release/Tag version {process.env.RELEASE_VERSION ?? '0.0.0'}, dev branch @{process.env.COMMIT_ID ?? '123456'} accessible in the **acap-v2** code repository. +ACAP 2.0 is the latest ACAP version. Its latest stable version is Release/Tag version {process.env.RELEASE_VERSION ?? '0.0.0'}, dev branch @{process.env.COMMIT_ID ?? '123456'} accessible in the **acap-v2** code repository. @@ -75,7 +75,7 @@ Version 2.0 and later versions may have new requirements that will thrive on new 1. Integration of climate risk trigger in public/admin crop recommendations and bulletin PDF generation 2. Support for multiple crops (cropping calendar and crop recommendations) - - Support new multiple recommendations/cropping calendar Excel files with new formats and structure + - Support new multiple recommendations/cropping calendar Excel files with new formats and structure. 3. Admin Pages - Cropping Calendar Excel file uploader - Crop Recommendations Excel file uploader @@ -90,7 +90,7 @@ Version 2.0 and later versions may have new requirements that will thrive on new 7. REST APIs (NodeJS) - New endpoints for processing cropping calendar and recommendations Excel file uploads - Migration of the [ACAP-RCMAS REST APIs](/post-installation/acap-rcmas-api) from the (forked) mirror environment with optional activation and deployment -8. _(More **"ACAP 2.1"** feature update details to follow, starting from the `dev` branch @commit **95a97cd**)_ +8. _(More **"ACAP 2.1"** feature update details to follow, starting from the `dev` branch @commit **95a97cd**. In the meantime, see the [link](https://github.com/amia-cis/acap-v2/releases/tag/v10.1.0-alpha.10) for more information.)_ #### Changed diff --git a/docs/pages/installation/client-setup.mdx b/docs/pages/installation/client-setup.mdx index fcb1cafd..20fc0774 100644 --- a/docs/pages/installation/client-setup.mdx +++ b/docs/pages/installation/client-setup.mdx @@ -21,7 +21,7 @@ The **client** `REGION_NAME` should be similar with the **server** `REGION_NAME` ```env copy REGION_NAME DEFAULT_PROVINCE -DEFAULT_MUNICIPALITY // --> Any municipality under the DEFAULT_PROVINCE +DEFAULT_MUNICIPALITY // --> Any municipality under the DEFAULT_PROVINCE also among the AMIA Villages NEXT_PUBLIC_FIREBASE_WEB_API_KEY NEXT_PUBLIC_FIREBASE_WEB_AUTHDOMAIN NEXT_PUBLIC_FIREBASE_WEB_PROJECT_ID @@ -71,6 +71,10 @@ RECOMMENDATIONS_CORN_EXCEL_FILE 3. Copy the the **/server/src/scripts/data/pagasa_seasonal_v2.xlsx** Excel file to the **"files"** directory 4. Use the **"files"** directory and its contents on localhost development but not push it to the repository. + + Follow the steps under the [Cropping Calendar](/post-installation/cropping-calendar/calendar-v2/#prepare-the-frontend--backend) and [Crop Recommendations](/post-installation/recommendations/recommendations-v2/#prepare-the-frontend--backend) Post-Installation steps to change the Excel templates uploaded during live deployment. + + ### Update environment variables after deployment Certain client environment variables, such as URLs (i.e., `BASE_URL_PROD`) will become available after deployment. Update the rest of the `.env` variables later after: diff --git a/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx b/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx index 738f3166..0eda13bf 100644 --- a/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx +++ b/docs/pages/post-installation/cropping-calendar/calendar-v2.mdx @@ -15,7 +15,7 @@ Follow this [link](/post-installation/cropping-calendar/calendar-v1) to view cr ### Data Format -The latest updates for ACAP 2.1, starting with @commit **95a97cd** in the **acap-v2 dev** branch, use a new Cropping Calendar Excel template different from the ones mentioned on this page. +The latest updates for **ACAP 2.1**, starting with @commit **95a97cd** in the **acap-v2 dev** branch, use a new Cropping Calendar Excel template different from the ones mentioned on this page. > These Cropping Calendars are only compatible up to @commit **ee49568** in the **acap-v2 dev** branch. @@ -92,6 +92,14 @@ 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 `corn_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. + +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. + + ### Login as Admin Login as an ACAP admin, then, navigate to the **Cropping Calendar Management** page in the `/admin/cropping-calendars` route. diff --git a/docs/pages/post-installation/recommendations/recommendations-v2.mdx b/docs/pages/post-installation/recommendations/recommendations-v2.mdx index 52532955..1bf2b582 100644 --- a/docs/pages/post-installation/recommendations/recommendations-v2.mdx +++ b/docs/pages/post-installation/recommendations/recommendations-v2.mdx @@ -13,7 +13,7 @@ Follow this [link](/post-installation/recommendations/recommendations-v1) to vi ## Data Format -The latest updates for ACAP 2.1, starting with @commit **95a97cd** in the **acap-v2 dev** branch, use a new Crop Recommendations Excel template different from the ones mentioned on this page. +The latest updates for **ACAP 2.1**, starting with @commit **95a97cd** in the **acap-v2 dev** branch, use a new Crop Recommendations Excel template different from the ones mentioned on this page. > These Crop Recommendations are only compatible up to @commit **ee49568** in the **acap-v2 dev** branch. @@ -62,6 +62,14 @@ 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. + +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. + + ### Login as Admin Login as an ACAP admin, then, navigate to the **Recommendations Management** page in the `/admin/manage-recommendations` route. diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx index 63b5e66e..a9b4b16b 100644 --- a/docs/theme.config.jsx +++ b/docs/theme.config.jsx @@ -34,7 +34,7 @@ export default { return ( <> - +