diff --git a/.env.example b/.env.example index 0025a98cf..38ea51f73 100644 --- a/.env.example +++ b/.env.example @@ -4,5 +4,6 @@ LOCAL_ENABLE_REDIRECTS=Yes LOCAL_ENABLE_TAGS=Yes LOCAL_ENABLE_USER_GUIDES=Yes LOCAL_ENABLE_DATA_PRODUCTS=Yes +LOCAL_ENABLE_OLD_VERSIONS=Yes LOCAL_ENABLE_NOTEBOOKS=Yes LOCAL_ENABLE_TECH_ALERTS_CHANGELOG=Yes diff --git a/.github/workflows/deploy-pr-preview.yaml b/.github/workflows/deploy-pr-preview.yaml index 8baa3be10..ca7d310f7 100644 --- a/.github/workflows/deploy-pr-preview.yaml +++ b/.github/workflows/deploy-pr-preview.yaml @@ -10,6 +10,7 @@ env: PR_PREVIEW_SUBDOMAIN: pr-${{github.event.pull_request.number}}-preview PR_PREVIEW_DEPLOY_LOG_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} PR_PREVIEW_BUCKET: s3://khpreview.dea.ga.gov.au + PR_PREVIEW_KH_DOCUMENTATION: https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/index.html permissions: id-token: write # For requesting the JWT used by OIDC Authentication @@ -35,7 +36,7 @@ jobs: steps: - name: Find Comment uses: peter-evans/find-comment@v3 - id: find-comment + id: fc with: issue-number: ${{ github.event.pull_request.number }} comment-author: 'github-actions[bot]' @@ -45,7 +46,7 @@ jobs: uses: peter-evans/create-or-update-comment@v4 with: issue-number: ${{github.event.pull_request.number}} - comment-id: ${{ steps.find-comment.outputs.comment-id }} + comment-id: ${{ steps.fc.outputs.comment-id }} edit-mode: replace body: | ## :hourglass: PR Preview is deploying ... @@ -55,6 +56,10 @@ jobs: Deploy log: View the log + + Learn more: + Read the documentation + - name: Checkout repository @@ -94,7 +99,7 @@ jobs: uses: peter-evans/create-or-update-comment@v4 with: issue-number: ${{github.event.pull_request.number}} - comment-id: ${{ steps.find-comment.outputs.comment-id }} + comment-id: ${{ steps.fc.outputs.comment-id }} edit-mode: replace body: | ## :star2: PR Preview is ready! @@ -108,6 +113,10 @@ jobs: Deploy log: View the log + + Learn more: + Read the documentation + diff --git a/README.md b/README.md index 57e49bf05..148208be5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # DEA Knowledge Hub -This is the repository for the [DEA Knowledge Hub](https://knowledge.dea.ga.gov.au/) website. +This is the repository for the [DEA Knowledge Hub](https://knowledge.dea.ga.gov.au/) website. (It was previously called 'DEA Docs' or 'dea-docs'.) -It was previously called 'DEA Docs' or 'dea-docs'. +Learn how to edit this content in the [Knowledge Hub documentation](https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/index.html). -To contribute content to this site, please follow the [publication process and git workflow](https://geoscienceau.sharepoint.com/:w:/r/sites/DEA/_layouts/15/Doc.aspx?sourcedoc=%7BE75F31A8-1648-4DA3-9E36-9BB8135921B2%7D&file=DEA%20Publication%20Process.docx&action=default&mobileredirect=true). diff --git a/docs/_templates/product-v1.rst b/docs/_templates/product-v1.rst index 0c0b8c306..5ee104487 100644 --- a/docs/_templates/product-v1.rst +++ b/docs/_templates/product-v1.rst @@ -81,7 +81,7 @@ {% if not is_latest_version %} .. admonition:: Old version - :class: danger + :class: note This is an old version of the product. See the `latest version <{{ data.latest_version_link }}>`_. diff --git a/docs/conf.py b/docs/conf.py index 93cbd100d..5cbbde699 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,6 +39,7 @@ ] exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_USER_GUIDES", "guides") exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_DATA_PRODUCTS", "data") +exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_OLD_VERSIONS", "data/old-version") exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_NOTEBOOKS", "notebooks") exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_TAGS", "tags") exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_TECH_ALERTS_CHANGELOG", "tech-alerts-changelog") diff --git a/docs/data/product/dea-fractional-cover-landsat/_data.yaml b/docs/data/product/dea-fractional-cover-landsat/_data.yaml index 8cbdc7470..bc5e6bf24 100644 --- a/docs/data/product/dea-fractional-cover-landsat/_data.yaml +++ b/docs/data/product/dea-fractional-cover-landsat/_data.yaml @@ -13,7 +13,7 @@ product_type: Derivative spatial_data_type: Raster time_span: start: 16/08/1986 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-fractional-cover-percentiles-landsat/_data.yaml b/docs/data/product/dea-fractional-cover-percentiles-landsat/_data.yaml index 1f39c181c..ce5d2c5d7 100644 --- a/docs/data/product/dea-fractional-cover-percentiles-landsat/_data.yaml +++ b/docs/data/product/dea-fractional-cover-percentiles-landsat/_data.yaml @@ -14,7 +14,7 @@ product_type: Derivative spatial_data_type: Raster time_span: start: 1987 - end: present + end: Present update_frequency: Yearly next_update: null product_ids: diff --git a/docs/data/product/dea-hotspots/_data.yaml b/docs/data/product/dea-hotspots/_data.yaml index 659aba26f..8fa35d3de 100644 --- a/docs/data/product/dea-hotspots/_data.yaml +++ b/docs/data/product/dea-hotspots/_data.yaml @@ -14,7 +14,7 @@ product_type: Data service spatial_data_type: Vector time_span: start: 27/08/2002 - end: present + end: Present update_frequency: Every 10 minutes next_update: null product_ids: null diff --git a/docs/data/product/dea-surface-reflectance-landsat-8-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-landsat-8-oli-tirs/_data.yaml index a62942542..06d6233e4 100644 --- a/docs/data/product/dea-surface-reflectance-landsat-8-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-landsat-8-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 19/03/2013 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-landsat-9-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-landsat-9-oli-tirs/_data.yaml index 3e8374d95..136a374f6 100644 --- a/docs/data/product/dea-surface-reflectance-landsat-9-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-landsat-9-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 31/10/2021 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbar-landsat-8-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-nbar-landsat-8-oli-tirs/_data.yaml index f81145c4b..1b9f85ba0 100644 --- a/docs/data/product/dea-surface-reflectance-nbar-landsat-8-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbar-landsat-8-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 19/03/2013 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbar-landsat-9-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-nbar-landsat-9-oli-tirs/_data.yaml index 748c474cf..7cf4f0117 100644 --- a/docs/data/product/dea-surface-reflectance-nbar-landsat-9-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbar-landsat-9-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 31/10/2021 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbart-landsat-8-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-nbart-landsat-8-oli-tirs/_data.yaml index e84377d99..566cd85f1 100644 --- a/docs/data/product/dea-surface-reflectance-nbart-landsat-8-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbart-landsat-8-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 19/03/2013 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbart-landsat-9-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-nbart-landsat-9-oli-tirs/_data.yaml index 4b3edc427..6529a3d47 100644 --- a/docs/data/product/dea-surface-reflectance-nbart-landsat-9-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbart-landsat-9-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 31/10/2021 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbart-sentinel-2a-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-nbart-sentinel-2a-msi/_data.yaml index 81d82fc36..248a28217 100644 --- a/docs/data/product/dea-surface-reflectance-nbart-sentinel-2a-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbart-sentinel-2a-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 12/07/2015 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-nbart-sentinel-2b-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-nbart-sentinel-2b-msi/_data.yaml index a13d0e641..7da3a7270 100644 --- a/docs/data/product/dea-surface-reflectance-nbart-sentinel-2b-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-nbart-sentinel-2b-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 30/06/2017 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-oa-landsat-8-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-oa-landsat-8-oli-tirs/_data.yaml index 4f216d938..b8a541e4e 100644 --- a/docs/data/product/dea-surface-reflectance-oa-landsat-8-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-oa-landsat-8-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 19/03/2013 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-oa-landsat-9-oli-tirs/_data.yaml b/docs/data/product/dea-surface-reflectance-oa-landsat-9-oli-tirs/_data.yaml index 948f58d95..9dbc12a18 100644 --- a/docs/data/product/dea-surface-reflectance-oa-landsat-9-oli-tirs/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-oa-landsat-9-oli-tirs/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 31/10/2021 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-oa-sentinel-2a-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-oa-sentinel-2a-msi/_data.yaml index 2de1a189b..f4c85a15a 100644 --- a/docs/data/product/dea-surface-reflectance-oa-sentinel-2a-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-oa-sentinel-2a-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 12/07/2015 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-oa-sentinel-2b-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-oa-sentinel-2b-msi/_data.yaml index bfc38f12f..028827778 100644 --- a/docs/data/product/dea-surface-reflectance-oa-sentinel-2b-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-oa-sentinel-2b-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 30/06/2017 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-sentinel-2a-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-sentinel-2a-msi/_data.yaml index 065bfccbd..4760cfd94 100644 --- a/docs/data/product/dea-surface-reflectance-sentinel-2a-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-sentinel-2a-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 12/07/2015 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-surface-reflectance-sentinel-2b-msi/_data.yaml b/docs/data/product/dea-surface-reflectance-sentinel-2b-msi/_data.yaml index ab766c6d0..8226b4b04 100644 --- a/docs/data/product/dea-surface-reflectance-sentinel-2b-msi/_data.yaml +++ b/docs/data/product/dea-surface-reflectance-sentinel-2b-msi/_data.yaml @@ -14,7 +14,7 @@ product_type: Baseline spatial_data_type: Raster time_span: start: 30/06/2017 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-water-observations-landsat/_data.yaml b/docs/data/product/dea-water-observations-landsat/_data.yaml index ab573d1e0..78c097ad8 100644 --- a/docs/data/product/dea-water-observations-landsat/_data.yaml +++ b/docs/data/product/dea-water-observations-landsat/_data.yaml @@ -14,7 +14,7 @@ product_type: Derivative spatial_data_type: Raster time_span: start: 16/08/1986 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-water-observations-sentinel-2-nrt/_data.yaml b/docs/data/product/dea-water-observations-sentinel-2-nrt/_data.yaml index 8d30c91f2..ede42f447 100644 --- a/docs/data/product/dea-water-observations-sentinel-2-nrt/_data.yaml +++ b/docs/data/product/dea-water-observations-sentinel-2-nrt/_data.yaml @@ -14,7 +14,7 @@ product_type: Derivative spatial_data_type: Raster time_span: start: 14/03/2023 - end: present + end: Present update_frequency: Daily next_update: null product_ids: diff --git a/docs/data/product/dea-water-observations-statistics-landsat/_data.yaml b/docs/data/product/dea-water-observations-statistics-landsat/_data.yaml index 0b64d4ea5..0d61a8218 100644 --- a/docs/data/product/dea-water-observations-statistics-landsat/_data.yaml +++ b/docs/data/product/dea-water-observations-statistics-landsat/_data.yaml @@ -14,7 +14,7 @@ product_type: Derivative spatial_data_type: Raster time_span: start: 1986 - end: present + end: Present update_frequency: Periodically next_update: null product_ids: diff --git a/docs/tech-alerts-changelog/_tech_alerts_changelog.md b/docs/tech-alerts-changelog/_tech_alerts_changelog.md index 98e0e076e..7ccb56a33 100644 --- a/docs/tech-alerts-changelog/_tech_alerts_changelog.md +++ b/docs/tech-alerts-changelog/_tech_alerts_changelog.md @@ -1,22 +1,22 @@ -% If status = green, class = tip -% All DEA systems are working as expected. There are no outstanding incidents or errors to report. -% See the [DEA monitoring dashboard](https://monitoring.dea.ga.gov.au/). -% If status = yellow, class = caution -% If status = red, class = danger +% See the DEA Tech Alerts and Changelog documentation: +% https://docs.dev.dea.ga.gov.au/public_services/dea_knowledge_hub/tech_alerts_changelog.html -:::{admonition} DEA system status: yellow +:::{admonition} DEA System Status :class: caution +% Change the 'class' to either: tip / caution / danger + +2024-03-21: We have received notice from NASA that Direct Broadcast satellite downloads from the Terra satellite are currently unavailable. This means that Terra-derived [DEA Hotspots](https://hotspots.dea.ga.gov.au/) are unavailable until further notice. -2024-03-14: We have implemented changes to improve the intermittent performance issues being experienced on DEA web services. We are continuing to work to fix this issue. +% All DEA systems are working as expected. There are no outstanding incidents or errors to report. See the [DEA monitoring dashboard](https://monitoring.dea.ga.gov.au/) to check the current status of DEA's services. ::: -:::{admonition} DEA Sentinel-2 contiguity fix: complete -:class: note +## 2024-03-21: DEA OWS services restored -See alert dated 2024-02-26 for more details. -::: +Outages affecting DEA Open Web Services (OWS) have been resolved. Work will be continuing over the coming months to further improve performance and reliability of these services. + +See the [DEA monitoring dashboard](https://monitoring.dea.ga.gov.au/) to check the current status of DEA's services. ## 2024-02-26: Sentinel-2 contiguity fix reprocessing complete diff --git a/make.bat b/make.bat deleted file mode 100644 index 42f4c3748..000000000 --- a/make.bat +++ /dev/null @@ -1,7 +0,0 @@ -REM This is the script for building the site locally on Windows. In the Command Prompt, enter the command: -REM make.bat - -docker build -t dea-knowledge-hub . - -docker run -it --rm --name dea-knowledge-hub --publish 8062:8062 --volume ".\docs\notebooks":"/docs/notebooks" --volume ".\output":"/output" --env-file .env dea-knowledge-hub -