From d91f24ca3a6ed2573728796585d2b8e12db4fb7f Mon Sep 17 00:00:00 2001 From: Alice Fage Date: Thu, 25 Jul 2024 15:26:13 +1200 Subject: [PATCH] fix: tweak wording --- workflows/raster/publish-odr.yaml | 12 ++++---- workflows/raster/standardising.yaml | 44 ++++++++++++++--------------- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/workflows/raster/publish-odr.yaml b/workflows/raster/publish-odr.yaml index c525943f..b5e6fd19 100644 --- a/workflows/raster/publish-odr.yaml +++ b/workflows/raster/publish-odr.yaml @@ -3,7 +3,7 @@ apiVersion: argoproj.io/v1alpha1 kind: WorkflowTemplate metadata: - name: publish-odr + name: test-afage-desc-publish-odr labels: linz.govt.nz/category: raster linz.govt.nz/data-type: raster @@ -26,13 +26,13 @@ spec: arguments: parameters: - name: version_argo_tasks - description: 'Change this to specify the version of the argo-tasks image e.g. "latest"' + description: 'Specify a version of the argo-tasks image to use, e.g. "4.1" or "latest"' value: 'v4' - name: ticket - description: 'Ticket ID e.g. "LI-1570"' + description: 'Ticket ID, e.g. "LI-1570"' value: '' - name: region - description: 'Region of the dataset' + description: 'Region of the dataset from the list below' value: 'new-zealand' enum: - 'antarctica' @@ -59,14 +59,14 @@ spec: description: 'S3 location of the source dataset' value: 's3://linz-imagery-staging/test/sample/' - name: target_bucket_name - description: 'The ODR bucket name to publish to e.g. "nz-imagery" or "nz-elevation"' + description: 'The ODR bucket name to publish to, e.g. "nz-imagery" or "nz-elevation"' value: '' enum: - 'nz-elevation' - 'nz-imagery' - '' - name: copy_option - description: 'Do not overwrite existing files ("no-clobber"), or "force" overwriting files in the target location' + description: 'Do not overwrite existing files with "no-clobber", or "force" overwriting files in the target location' value: '--no-clobber' enum: - '--no-clobber' diff --git a/workflows/raster/standardising.yaml b/workflows/raster/standardising.yaml index 68fa7037..f9efc82c 100644 --- a/workflows/raster/standardising.yaml +++ b/workflows/raster/standardising.yaml @@ -3,7 +3,7 @@ apiVersion: argoproj.io/v1alpha1 kind: WorkflowTemplate metadata: - name: imagery-standardising + name: test-afage-desc-imagery-standardising labels: linz.govt.nz/category: raster linz.govt.nz/data-type: raster @@ -26,19 +26,19 @@ spec: arguments: parameters: - name: version_argo_tasks - description: 'Change this to specify the version of the argo-tasks image e.g. "latest"' + description: 'Specify a version of the argo-tasks image to use, e.g. "4.1" or "latest"' value: 'v4' - name: version_basemaps_cli - description: 'Change this to specify the version of the basemaps-cli image e.g. "latest"' + description: 'Specify a version of the basemaps-cli image to use, e.g. "v7.1" or "latest"' value: 'v7' - name: version_topo_imagery - description: 'Change this to specify the version of the topo-imagery image e.g. "latest"' + description: 'Specify a version of the topo-imagery image to use, e.g. "4.8" or "latest"' value: 'v4' - name: ticket - description: 'Ticket ID e.g. "LI-1570"' + description: 'Ticket ID, e.g. "LI-1570"' value: '' - name: region - description: 'Region of the dataset' + description: 'Region of the dataset from the list below' value: 'new-zealand' enum: - 'antarctica' @@ -65,10 +65,10 @@ spec: description: 'S3 location of the source dataset(s). Separate multiple sources with a semicolon (;) for merging. Target imagery will be layered (bottom to top) in order specified (left to right)' value: 's3://linz-imagery-staging/test/sample/' - name: include - description: 'Regular expression pattern match for paths/files to include' + description: 'Regular expression pattern match for paths/files to include e.g ".tiff?$"' value: '.tiff?$' - name: scale - description: 'Scale of the imagery e.g. "10000"' + description: 'Scale of the standardised output imagery, e.g. "10000"' value: '500' enum: - '500' @@ -79,13 +79,13 @@ spec: - '50000' - 'None' - name: validate - description: 'Validate the tiles' + description: 'Validate the tiles match LINZ map sheet tile index and there are no duplicate tiles' value: 'true' enum: - 'false' - 'true' - name: retile - description: 'Retile the dataset' + description: 'Retile the dataset to the output scale specified in the "scale" parameter' value: 'false' enum: - 'true' @@ -94,13 +94,13 @@ spec: description: 'EPSG of the source files' value: '2193' - name: target_epsg - description: 'EPSG of the standardised files' + description: 'EPSG of the standardised output files' value: '2193' - name: group - description: 'How many output tiles to group together in each standardising task' + description: 'How many output tiles to process in each standardising task "pod". Change if you have resource or performance issues when standardising a dataset.' value: '50' - name: compression - description: 'Compression type for the standardised TIFFs' + description: 'Compression type to use when standardising TIFFs, e.g. "webp" for imagery or "dem_lerc" for elevation data' value: 'webp' enum: - 'webp' @@ -130,7 +130,7 @@ spec: - 'dsm' - 'satellite-imagery' - name: gsd - description: 'Dataset GSD (e.g., "0.3m") - the "m" must be included' + description: 'Dataset GSD, e.g., "0.3m" (the "m" must be included)' - name: producer description: 'The producer of the source dataset, e.g. aerial or bathymetric survey company' value: 'Unknown' @@ -270,13 +270,13 @@ spec: description: '(Optional) List of imagery licensors, separated by semicolon (;). Has no effect unless a semicolon delimited list is entered.' value: '' - name: start_datetime - description: 'Dataset capture start date in format YYYY-MM-DD e.g. "2024-01-14"' + description: 'Dataset capture start date in numeric format YYYY-MM-DD, e.g. "2024-01-14"' value: 'YYYY-MM-DD' - name: end_datetime - description: 'Dataset capture end date in format YYYY-MM-DD e.g. "2024-02-23"' + description: 'Dataset capture end date in numeric format YYYY-MM-DD, e.g. "2024-02-23"' value: 'YYYY-MM-DD' - name: geographic_description - description: '(Optional) Additional datatset description, to be used in the title in place of the Region (e.g., "Hamilton")' + description: '(Optional) Additional datatset description, to be used in the title in place of the Region, e.g. "Hamilton"' value: '' - name: lifecycle description: 'The release lifecycle status of the dataset, e.g. "completed or "ongoing"' @@ -288,19 +288,19 @@ spec: - 'completed' - 'deprecated' - name: event - description: '(Optional) Event name if dataset has been captured in association with an event (e.g., "Top of the South Floods")' + description: '(Optional) Event name if dataset has been captured in association with an event, e.g. "Top of the South Floods"' value: '' - name: historic_survey_number - description: '(Optional) Survey Number associated with historical datasets, (e.g. "SN8844")' + description: '(Optional) Survey Number associated with historical datasets, e.g. "SN8844"' value: '' - name: publish_to_odr - description: 'Create a Pull Request for publishing to imagery or elevation ODR buckets' + description: 'Create a Pull Request for publishing to imagery or elevation ODR bucket' value: 'false' enum: - 'false' - 'true' - name: target_bucket_name - description: 'The ODR bucket name to publish to e.g. "nz-imagery" or "nz-elevation"' + description: 'The ODR bucket name to publish to, e.g. "nz-imagery" or "nz-elevation"' value: '' enum: - '' @@ -308,7 +308,7 @@ spec: - 'nz-elevation' - '' - name: copy_option - description: 'Do not overwrite existing files ("no-clobber"), or "force" overwriting files in the target location' + description: 'Do not overwrite existing files with "no-clobber", or "force" overwriting files in the target location' value: '--no-clobber' enum: - '--no-clobber'