From f79495fe215370e023baa700de8c7542db23fee0 Mon Sep 17 00:00:00 2001 From: Sean Arms <67096+lesserwhirls@users.noreply.github.com> Date: Wed, 20 Nov 2024 08:50:48 -0700 Subject: [PATCH] Improve NCSS docs and upgrade guide Call out changes to NCSS service elements in 5.x (i.e. GRID and POINT have different service elements). Addresses Unidata/tds#544. --- .../tds_configuration/AddingNcss.md | 15 +++++++++++---- .../tds_configuration/ConfigCatalog.md | 4 ++-- .../src/site/pages/thredds/TdsServices.md | 18 ++++++++++++++---- .../src/site/pages/thredds/ViewersRef.md | 2 +- .../tds_configuration/AddingNcss.md | 15 +++++++++++---- .../tds_configuration/AddingOgcIsoServices.md | 4 ++-- .../tds_configuration/ConfigCatalog.md | 4 ++-- .../src/site/pages/thredds/TdsServices.md | 14 +++++++++++--- .../src/site/pages/thredds/ViewersRef.md | 2 +- .../pages/tds_tutorial/production/Upgrade.md | 14 +++++++++++++- .../tds_configuration/AddingNcss.md | 15 +++++++++++---- .../tds_configuration/AddingOgcIsoServices.md | 4 ++-- .../tds_configuration/ConfigCatalog.md | 4 ++-- .../src/site/pages/thredds/TdsServices.md | 14 +++++++++++--- .../src/site/pages/thredds/ViewersRef.md | 2 +- .../pages/tds_tutorial/production/Upgrade.md | 14 +++++++++++++- .../tds_configuration/AddingNcss.md | 15 +++++++++++---- .../tds_configuration/AddingOgcIsoServices.md | 4 ++-- .../tds_configuration/ConfigCatalog.md | 4 ++-- .../src/site/pages/thredds/TdsServices.md | 14 +++++++++++--- .../src/site/pages/thredds/ViewersRef.md | 2 +- 21 files changed, 135 insertions(+), 49 deletions(-) diff --git a/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md b/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md index 5e1d9a526f..84edc8076f 100644 --- a/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md +++ b/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md @@ -32,21 +32,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo ## Serving Datasets With NCSS -In your configuration catalogs, you must define the service like this: +In your configuration catalogs, you must define the service based on the type of data being served. +For Feature Type `GRID`, use: ~~~xml - + +~~~ + +For Feature Types `POINT` or `STATION`, use: + +~~~xml + ~~~ Then as usual, add the service to any datasets that you want served, e.g.: ~~~xml - subsetServer + ncssGrid ~~~ -Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. +Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. ## Restrictions On What Files Can Be Served diff --git a/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md b/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md index 659ea2a262..3a3f0b9681 100644 --- a/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md +++ b/docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values * NetCDF Subset Service (Grid Data) ~~~xml - + ~~~ * NetCDF Subset Service (Point Data) ~~~xml - + ~~~ * WCS diff --git a/docs/adminguide/src/site/pages/thredds/TdsServices.md b/docs/adminguide/src/site/pages/thredds/TdsServices.md index 512071add2..d9e5b250c1 100644 --- a/docs/adminguide/src/site/pages/thredds/TdsServices.md +++ b/docs/adminguide/src/site/pages/thredds/TdsServices.md @@ -229,13 +229,23 @@ The `serviceType` and `base` values are **required** in the following examples: ~~~ #### NetCDF Subset Service - + +## Serving Datasets With NCSS + +For Feature Type `GRID`, use: + +~~~xml + +~~~ + +For Feature Types `POINT` or `STATION`, use: + ~~~xml - + ~~~ #### WCS - + ~~~xml ~~~ @@ -275,7 +285,7 @@ The `serviceType` and `base` values are **required** in the following examples: - + diff --git a/docs/adminguide/src/site/pages/thredds/ViewersRef.md b/docs/adminguide/src/site/pages/thredds/ViewersRef.md index 1d40d581be..83b7878509 100644 --- a/docs/adminguide/src/site/pages/thredds/ViewersRef.md +++ b/docs/adminguide/src/site/pages/thredds/ViewersRef.md @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use. - + diff --git a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md index 04876ec0af..c91ee97de8 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md +++ b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo ## Serving Datasets With NCSS -In your configuration catalogs, you must define the service like this: +In your configuration catalogs, you must define the service based on the type of data being served. +For Feature Type `GRID`, use: ~~~xml - + +~~~ + +For Feature Types `POINT` or `STATION`, use: + +~~~xml + ~~~ Then as usual, add the service to any datasets that you want served, e.g.: ~~~xml - subsetServer + ncssGrid ~~~ -Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. +Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `ncssGrid` and base must be _exactly_ as shown. ## Restrictions On What Files Can Be Served diff --git a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md index 66e1e750df..3d29a39bfc 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md +++ b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md @@ -65,7 +65,7 @@ Adding them to an existing compound service would look something like this: - + ~~~ @@ -80,7 +80,7 @@ For instance, adding to the same compound service as above: - + diff --git a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md index 89a7ff1fde..cfc9c5bc13 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md +++ b/docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values * NetCDF Subset Service (Grid Data) ~~~xml - + ~~~ * NetCDF Subset Service (Point Data) ~~~xml - + ~~~ * WCS diff --git a/docs/devguide/src/site/pages/thredds/TdsServices.md b/docs/devguide/src/site/pages/thredds/TdsServices.md index 8b9addd6da..d7c4ffc375 100644 --- a/docs/devguide/src/site/pages/thredds/TdsServices.md +++ b/docs/devguide/src/site/pages/thredds/TdsServices.md @@ -229,9 +229,17 @@ The `serviceType` and `base` values are **required** in the following examples: ~~~ #### NetCDF Subset Service - + +For Feature Type `GRID`, use: + +~~~xml + +~~~ + +For Feature Types `POINT` or `STATION`, use: + ~~~xml - + ~~~ #### WCS @@ -275,7 +283,7 @@ The `serviceType` and `base` values are **required** in the following examples: - + diff --git a/docs/devguide/src/site/pages/thredds/ViewersRef.md b/docs/devguide/src/site/pages/thredds/ViewersRef.md index 1d40d581be..83b7878509 100644 --- a/docs/devguide/src/site/pages/thredds/ViewersRef.md +++ b/docs/devguide/src/site/pages/thredds/ViewersRef.md @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use. - + diff --git a/docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md b/docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md index 3fabad9828..8cad43f1c6 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md @@ -38,7 +38,19 @@ Deprecated classes and methods have been removed, and the module structure and t ### Netcdf Subset Service (NCSS) NCSS queries and responses have been improved and clarified. -Generally the previous queries are backwards compatible. See [NCSS Reference](netcdf_subset_service_ref.html) for details. +Generally the previous queries are backwards compatible. +See [NCSS Reference](netcdf_subset_service_ref.html) for details. + +Catalog (config and client) base changes: +* NCSS service has been split and now has two different paths, depending on the feature type of data being served. +* For `GRID`, use: + ~~~ + + ~~~ + and for `POINT` or `STATION`, use: + ~~~xml + + ~~~ New functionality: * 2D time can now be handled for gridded datasets, with addition of `runtime` and `timeOffset` parameters. diff --git a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md index 78027db59f..026df1db77 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo ## Serving Datasets With NCSS -In your configuration catalogs, you must define the service like this: +In your configuration catalogs, you must define the service based on the type of data being served. +For Feature Type `GRID`, use: ~~~xml - + +~~~ + +For Feature Types `POINT` or `STATION`, use: + +~~~xml + ~~~ Then as usual, add the service to any datasets that you want served, e.g.: ~~~xml - subsetServer + ncssGrid ~~~ -Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. +Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. ## Restrictions On What Files Can Be Served diff --git a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md index d733c7e966..bf26e9f812 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md @@ -65,7 +65,7 @@ Adding them to an existing compound service would look something like this: - + ~~~ @@ -80,7 +80,7 @@ For instance, adding to the same compound service as above: - + diff --git a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md index 85c2b3d3b1..1d47f776d0 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values * NetCDF Subset Service (Grid Data) ~~~xml - + ~~~ * NetCDF Subset Service (Point Data) ~~~xml - + ~~~ * WCS diff --git a/docs/quickstart/src/site/pages/thredds/TdsServices.md b/docs/quickstart/src/site/pages/thredds/TdsServices.md index 3acfdedad0..d331f5118e 100644 --- a/docs/quickstart/src/site/pages/thredds/TdsServices.md +++ b/docs/quickstart/src/site/pages/thredds/TdsServices.md @@ -229,9 +229,17 @@ The `serviceType` and `base` values are **required** in the following examples: ~~~ #### NetCDF Subset Service - + +For Feature Type `GRID`, use: + +~~~xml + +~~~ + +For Feature Types `POINT` or `STATION`, use: + ~~~xml - + ~~~ #### WCS @@ -275,7 +283,7 @@ The `serviceType` and `base` values are **required** in the following examples: - + diff --git a/docs/quickstart/src/site/pages/thredds/ViewersRef.md b/docs/quickstart/src/site/pages/thredds/ViewersRef.md index 1d40d581be..83b7878509 100644 --- a/docs/quickstart/src/site/pages/thredds/ViewersRef.md +++ b/docs/quickstart/src/site/pages/thredds/ViewersRef.md @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use. - + diff --git a/docs/userguide/src/site/pages/tds_tutorial/production/Upgrade.md b/docs/userguide/src/site/pages/tds_tutorial/production/Upgrade.md index 0c39a4a034..c3667b4bca 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/production/Upgrade.md +++ b/docs/userguide/src/site/pages/tds_tutorial/production/Upgrade.md @@ -37,7 +37,19 @@ Deprecated classes and methods have been removed, and the module structure and t ### Netcdf Subset Service (NCSS) NCSS queries and responses have been improved and clarified. -Generally the previous queries are backwards compatible. See [NCSS Reference](netcdf_subset_service_ref.html) for details. +Generally the previous queries are backwards compatible. +See [NCSS Reference](netcdf_subset_service_ref.html) for details. + +Catalog (config and client) base changes: +* NCSS service has been split and now has two different paths, depending on the feature type of data being served. +* For `GRID`, use: + ~~~ + + ~~~ + and for `POINT` or `STATION`, use: + ~~~xml + + ~~~ New functionality: * 2D time can now be handled for gridded datasets, with addition of `runtime` and `timeOffset` parameters. diff --git a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md index 478137c9e5..8ca90d884d 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md +++ b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo ## Serving Datasets With NCSS -In your configuration catalogs, you must define the service like this: +In your configuration catalogs, you must define the service based on the type of data being served. +For Feature Type `GRID`, use: ~~~xml - + +~~~ + +For Feature Types `POINT` or `STATION`, use: + +~~~xml + ~~~ Then as usual, add the service to any datasets that you want served, e.g.: ~~~xml - subsetServer + ncssGrid ~~~ -Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. +Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown. ## Restrictions On What Files Can Be Served diff --git a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md index 5863f52990..e393ed61ae 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md +++ b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md @@ -86,7 +86,7 @@ Adding them to an existing compound service would look something like this: - + ~~~ @@ -101,7 +101,7 @@ For instance, adding to the same compound service as above: - + diff --git a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md index d5319d89a5..b3bdc8d2e1 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md +++ b/docs/userguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values * NetCDF Subset Service (Grid Data) ~~~xml - + ~~~ * NetCDF Subset Service (Point Data) ~~~xml - + ~~~ * WCS diff --git a/docs/userguide/src/site/pages/thredds/TdsServices.md b/docs/userguide/src/site/pages/thredds/TdsServices.md index c2e2b9cd62..b591165a7e 100644 --- a/docs/userguide/src/site/pages/thredds/TdsServices.md +++ b/docs/userguide/src/site/pages/thredds/TdsServices.md @@ -226,9 +226,17 @@ The `serviceType` and `base` values are **required** in the following examples: ~~~ #### NetCDF Subset Service - + +For Feature Type `GRID`, use: + +~~~xml + +~~~ + +For Feature Types `POINT` or `STATION`, use: + ~~~xml - + ~~~ #### WCS @@ -272,7 +280,7 @@ The `serviceType` and `base` values are **required** in the following examples: - + diff --git a/docs/userguide/src/site/pages/thredds/ViewersRef.md b/docs/userguide/src/site/pages/thredds/ViewersRef.md index 08c4dacf3d..a1a867213c 100644 --- a/docs/userguide/src/site/pages/thredds/ViewersRef.md +++ b/docs/userguide/src/site/pages/thredds/ViewersRef.md @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use. - +