From 0c287ace247a18276c23ab262bc7c413cb95a3b4 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Fri, 1 Aug 2025 08:22:26 -0400 Subject: [PATCH] replace tabs with spaces, capitalize Reference Implementation --- guide/sections/part2/global-services.adoc | 10 +++++----- guide/sections/part2/operations.adoc | 2 +- guide/sections/part2/wis2-architecture.adoc | 14 +++++++------- guide/sections/part2/wis2node.adoc | 4 ++-- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/guide/sections/part2/global-services.adoc b/guide/sections/part2/global-services.adoc index 3dcaa00..92c9919 100644 --- a/guide/sections/part2/global-services.adoc +++ b/guide/sections/part2/global-services.adoc @@ -5,9 +5,9 @@ The successful operation of WIS2 depends on a set of Global Services running wel Depending on the nature of the Global Service, the following are the minimum capabilities needed to ensure that the level of service as a whole reaches 100% (or very close): -* Three Global Brokers, with each Global Broker connected to at least two other Global Brokers; -* Three Global Caches, with each Global Cache connected to at least two Global Brokers and capable of downloading data from all WIS2 Nodes providing core data; -* Two Global Discovery Catalogues, with each Global Discovery Catalogue connected to at least one Global Broker; +* Three Global Brokers, with each Global Broker connected to at least two other Global Brokers; +* Three Global Caches, with each Global Cache connected to at least two Global Brokers and capable of downloading data from all WIS2 Nodes providing core data; +* Two Global Discovery Catalogues, with each Global Discovery Catalogue connected to at least one Global Broker; * Two Global Monitors - each Global Monitor should scrape the metrics from all other Global Services In addition to the above, WIS architecture can accommodate adding (or removing) Global Services. Candidate WIS centres should inform their WIS NFP and contact the WMO Secretariat to discuss their offer to provide a Global Service. @@ -183,11 +183,11 @@ In WIS2, Global Caches provide access to WMO core data for data consumers. This * A Global Discovery Catalogue may initialize itself (cold start) from a zip file of all WCMP2 records published. * As a convention, a Global Discovery Catalogue's centre-id will be ``tld-{centre-name}-global-discovery-catalogue``. -===== 2.7.5.2 Global Discovery Catalogue reference implementation: wis2-gdc +===== 2.7.5.2 Global Discovery Catalogue Reference Implementation: wis2-gdc To provide a Global Discovery Catalogue, Members may use whichever software components they consider most appropriate to comply with the WIS2 technical regulations. -To assist Members in participating in WIS2, a free and open-source Global Discovery Catalogue reference implementation, wis2-gdc, is available for download and use. wis2-gdc builds on mature and robust free and open-source software components that are widely adopted for operational use. +To assist Members in participating in WIS2, a free and open-source Global Discovery Catalogue Reference Implementation, wis2-gdc, is available for download and use. wis2-gdc builds on mature and robust free and open-source software components that are widely adopted for operational use. wis2-gdc provides the functionality required for the Global Discovery Catalogue, including the following technical functions: diff --git a/guide/sections/part2/operations.adoc b/guide/sections/part2/operations.adoc index bbadcfb..00890bd 100644 --- a/guide/sections/part2/operations.adoc +++ b/guide/sections/part2/operations.adoc @@ -277,7 +277,7 @@ harvest and merge these catalogues, creating a global map of the ocean data. IODE harvests all metadata shared by ODIS partners, combines these metadata and creates a knowledge graph, and processes these metadata to export derivative products (for example, diagnostic reports and cloud-optimized data products). -The Ocean InfoHub (OIH) system is IODE's reference implementation of a +The Ocean InfoHub (OIH) system is IODE's Reference Implementation of a discovery system leveraging ODIS. ODIS architecture and tools are free and open-source software (FOSS), with regular releases published for the community. diff --git a/guide/sections/part2/wis2-architecture.adoc b/guide/sections/part2/wis2-architecture.adoc index 7859dbc..15621ad 100644 --- a/guide/sections/part2/wis2-architecture.adoc +++ b/guide/sections/part2/wis2-architecture.adoc @@ -38,17 +38,17 @@ These roles are outlined below. ==== 2.2.3 Global Service operator * To ensure highly available global data exchange, a WIS centre may operate one or more Global Services: - i) The Global Discovery Catalogue enables users to search all datasets provided by data publishers and discover where and how to interact with those datasets (for example, to subscribe to updates, to access/download/visualize data, to access more detailed information about the dataset); - ii) A Global Broker provides highly available messaging services through which users may subscribe to notifications about all datasets provided by data publishers; - iii) A Global Cache provides a highly available download service for cached copies of core data downloaded from data publishers’ web services; - iv) A Global Monitor gathers and displays system performance, data availability, and other metrics from all WIS2 Nodes and Global Services. + i) The Global Discovery Catalogue enables users to search all datasets provided by data publishers and discover where and how to interact with those datasets (for example, to subscribe to updates, to access/download/visualize data, to access more detailed information about the dataset); + ii) A Global Broker provides highly available messaging services through which users may subscribe to notifications about all datasets provided by data publishers; + iii) A Global Cache provides a highly available download service for cached copies of core data downloaded from data publishers’ web services; + iv) A Global Monitor gathers and displays system performance, data availability, and other metrics from all WIS2 Nodes and Global Services. ==== 2.2.4 Data consumer * This role represents anyone wanting to find, access, and use data from WIS2. Examples include NMHSs, government agencies, research institutions, private sector organizations, and so forth. * Data consumers search or browse a Global Discovery Catalogue (or another search engine) to discover the datasets that meet their needs ("datasets of interest"). -* Data consumers subscribe via a Global Broker to receive notification messages about the availability of data or metadata associated with their datasets of interest. -* Data consumers determine whether the data or metadata referenced in the notification messages are required. -* Data consumers download data from a Global Cache or WIS2 Node. +* Data consumers subscribe via a Global Broker to receive notification messages about the availability of data or metadata associated with their datasets of interest. +* Data consumers determine whether the data or metadata referenced in the notification messages are required. +* Data consumers download data from a Global Cache or WIS2 Node. === 2.3 WIS2 specifications diff --git a/guide/sections/part2/wis2node.adoc b/guide/sections/part2/wis2node.adoc index a14a002..8dc5c44 100644 --- a/guide/sections/part2/wis2node.adoc +++ b/guide/sections/part2/wis2node.adoc @@ -93,11 +93,11 @@ A WIS2 Node must be able to publish datasets and compliant discovery metadata. T If contacted by a Global Monitor for a performance issue via a GISC, the WIS2 Node should provide metrics to the GISC and the Global Monitor when service is restored to inform them of the resolution of the issue. -==== 2.6.3 WIS2 Node reference implementation: WIS2 in a box +==== 2.6.3 WIS2 Node Reference Implementation: WIS2 in a box When providing a WIS2 Node, Members may use whichever software components they consider most appropriate to comply with the WIS2 technical regulations. -To assist Members, a free and open-source reference implementation called “WIS2 in a box” (wis2box) is available. wis2box implements the requirements for a WIS2 Node and contains additional enhancements. wis2box is built free and open-source software components that are mature, robust and widely adopted for operational use. +To assist Members, a free and open-source Reference Implementation called “WIS2 in a box” (wis2box) is available. wis2box implements the requirements for a WIS2 Node and contains additional enhancements. wis2box is built free and open-source software components that are mature, robust and widely adopted for operational use. wis2box provides the functionality required for both data publisher and data consumer roles, as well as the following technical functions: