Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add or change section titles as well as inline references #177

Merged
merged 1 commit into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions guide/sections/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
== Introduction
=== Purpose
== Purpose of this Guide

In conjunction with the https://library.wmo.int/idurl/4/68731[_Manual on the WMO Information System_] (WMO-No. 1060), Volume II – WMO Information System 2.0 (_Manual on WIS_, Volume II), the present _Guide to the WMO Information System_ (WMO-No. 1061), Volume II – WMO Information System 2.0 _(Guide to WIS_, Volume II) is designed to ensure adequate uniformity and standardization in the data, information and communication practices, procedures and specifications employed by WMO Members in the operation of the WMO Information System 2.0 (WIS2) as it supports the mission of the Organization. The _Manual on WIS_, Volume II contains standard and recommended practices, procedures and specifications. The _Guide to WIS_, Volume II contains additional information concerning practices, procedures and specifications that Members are invited to follow or implement in establishing and conducting their arrangements in compliance with the WMO technical regulations and in developing meteorological and hydrological services.
6 changes: 3 additions & 3 deletions guide/sections/part1/data-consumer.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== 1.2 Data consumer
=== 1.2 Information for the data consumer

Data consumers wanting to use data published via WIS2 should read the guidance presented here. In addition, a list of references to informative material in this Guide and elsewhere is provided at the end of this section.

Expand All @@ -8,7 +8,7 @@ The first step to using data published via WIS2 is to determine which dataset or

A key component of dataset records in the Global Discovery Catalogue is "actionable" links. A dataset record provides one or more links, each clearly identifying its nature and purpose (informational, direct download, application programming interface (API), subscription) so that the data consumer can interact with the data accordingly. For example, a dataset record may include a link to subscribe to notifications about the data(see <<_1_2_2_how_to_subscribe_to_notifications_about_the_availability_of_new_data>>), or an API, or an offline archive retrieval service.

The Global Discovery Catalogue is accessible via an API and provides a low-barrier mechanism (see <<_2_2_4_global_discovery_catalogue>>). Internet search engines are able to index the discovery metadata in the Global Discovery Catalogue, thereby providing data consumers with an alternative means to search for WIS2 data.
The Global Discovery Catalogue is accessible via an API and provides a low-barrier mechanism (see <<_2_4_4_global_discovery_catalogue>>). Internet search engines are able to index the discovery metadata in the Global Discovery Catalogue, thereby providing data consumers with an alternative means to search for WIS2 data.

==== 1.2.2 How to subscribe to notifications about the availability of new data

Expand Down Expand Up @@ -78,7 +78,7 @@ When using data from WIS2, data consumers:

Data consumers wanting to use data published via WIS2 should, at a minimum, read the following sections:

* <<_1_1_introduction_to_wis2>>
* <<_part_i_introduction>>
* <<_2_1_wis2_architecture>>
* <<_2_2_roles_in_wis2>>
* <<_2_4_wis2_components>>
Expand Down
20 changes: 10 additions & 10 deletions guide/sections/part1/data-publisher.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
=== 1.3 Data publisher
=== 1.3 Information for the data publisher

Data publishers wanting to share authoritative Earth system data with the WMO community should read the guidance presented here. A list of references to informative material in this Guide and elsewhere is provided at the end of this section.

==== 1.3.1 How to get started

The first step is to consider the data, how they can be conceptually grouped into one or more datasets (see <<_1_1_4_why_are_datasets_so_important?>>), and whether they are core or recommended data, as per the WMO Unified Data Policy (Resolution 1 (Cg-Ext(2021))) .
The first step is to consider the data, how they can be conceptually grouped into one or more datasets (see <<_1_1_4_why_are_datasets_so_important>>), and whether they are core or recommended data, as per the WMO Unified Data Policy (Resolution 1 (Cg-Ext(2021))) .

Next, it is important to consider where the data are published. If the data relate to a specific country or territory, they should be published through a National Centre (NC). If they relate to a region, programme, or other specialized function within WMO, they should be published through a Data Collection or Production Centre (DCPC). The functional requirements for NCs and DCPCs are described in the _Manual on WIS_, Volume II - Part III Functions of WIS.

All NCs and DCPCs are affiliated with a Global Information System Centre (GISC), which is responsible for helping to establish efficient and effective data sharing on WIS. The affiliated GISC can assist in getting the data onto WIS2.

It may be possible to identify an existing NC or DCPC that can publish the data. Alternatively, it may be necessary to establish a new NC or DCPC. The main distinction between these two centres is that an NC is designated by a Member, whereas a DCPC is designated by a WMO or related international programme and/or a regional association.

Both NCs and DCPCs require the operation of a WIS2 Node (see <<_2_4_2_wis2_node>>). The procedure for registering a new WIS2 Node is provided in <<_2_6_1_1_registration_and_decommissioning_of_a_wis2_node>>.
Both NCs and DCPCs require the operation of a WIS2 Node (see <<_2_4_1_wis2_node>>). The procedure for registering a new WIS2 Node is provided in <<_2_6_1_1_registration_and_decommissioning_of_a_wis2_node>>.

Once the scope of the datasets has been determined, the applicable data policy has been identified, and a WIS2 Node is ready for data publication, the process can proceed to the next step: providing discovery metadata.

Expand Down Expand Up @@ -173,21 +173,21 @@ Note that some data archives, for example, Essential Climate Variables, are cate

Data publishers planning to operate WIS2 Nodes, at a minimum, should read the following sections:

* <<_1_1_introduction_to_wis2>>
* <<_part_i_introduction>>
* <<_2_1_wis2_architecture>>
* <<_2_2_roles_in_wis2>>
* <<_2_4_components_of_wis2>>
* <<_2_4_wis2_components>>
* <<_2_6_implementation_and_operation_of_a_wis2_node>>

The following sections are recommended for further reading:

* <<_3_1_information_management>>
* <<_4_1_security>>
* <<_5_1_competencies>>
* <<_part_iii_information_management>>
* <<_part_iv_security>>
* <<_part_v_competencies>>

Note that _4.1. Security_ and _5.1. Competencies_ reference content originally published for WIS1. These sections remain largely applicable and will be updated in subsequent releases of this Guide.
Note that _PART IV. Security_ and _PART V. Competencies_ reference content originally published for WIS1. These sections remain largely applicable and will be updated in subsequent releases of this Guide.

Data publishers publishing aviation weather data via WIS2 for onward transmission through the International Civil Aviation Organization (ICAO) System Wide Information Management (SWIM), should also read <<_2_8_8_1_publishing_aviation_weather_data_through_wis2_into_icao_swim>>.
Data publishers publishing aviation weather data via WIS2 for onward transmission through the International Civil Aviation Organization (ICAO) System Wide Information Management (SWIM), should also read <<_2_8_1_1_publishing_meteorological_data_through_wis2_into_icao_swim>>.

Finally, data publishers should also review the specifications in the _Manual on WIS_, Volume II:

Expand Down
2 changes: 1 addition & 1 deletion guide/sections/part1/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

== PART I
== PART I. Introduction

include::introduction.adoc[]

Expand Down
4 changes: 3 additions & 1 deletion guide/sections/part1/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== 1.1 Introduction to WIS2
=== 1.1 Background

Since the Global Telecommunication System (GTS) entered operational life in 1971, it has been a reliable real-time exchange mechanism of essential data for WMO Members.

Expand Down Expand Up @@ -53,10 +53,12 @@ A dataset may be published as an immutable resource (such as data collected from
A dataset may be represented as a single, structured file or object (for example, a CSV file in which each row represents a data record) or as thousands of consistent files (for example, output from a reanalysis model encoded as many thousands of General Regularly-distributed Information in Binary form (GRIB) files). Determining the best way to represent a dataset is beyond the scope of this Guide – there are many factors to consider. The key point here is that the dataset is considered a single, identifiable resource irrespective of how it is represented.

Because data are grouped into a single, conceptual resource (that is, the dataset) it is possible to:

* Assign this resource an identifier and use this identifier to unambiguously refer to collections of data;
* Make statements about the dataset (that is, metadata) and infer that these statements apply to the entire collection.

The dataset concept is central to WIS2:

* Discovery metadata about datasets are published, as specified in the _Manual on WIS_, Volume II – Appendix F. WMO Core Metadata Profile (Version 2);
* Data consumers can search for datasets that contain relevant data using the Global Discovery Catalogue (see <<_2_4_4_global_discovery_catalogue>>);
* Data consumers can subscribe to notifications about updates to a dataset via a Global Broker (see <<_2_4_2_global_broker>>);
Expand Down
2 changes: 1 addition & 1 deletion guide/sections/part2/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
== PART II
== PART II. Architecture, implementation and operations

include::wis2-architecture.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion guide/sections/part2/wis2-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Leveraging existing open standards, WIS2 defines the following specifications in

Refer to the _Manual on WIS_, Volume II for details.

=== 2.4 Components of WIS2
=== 2.4 WIS2 Components

// TODO: add refs to other parts of the Guide describing these components

Expand Down
3 changes: 2 additions & 1 deletion guide/sections/part2/wis2node.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ image::images/add-wis2node.png[Adding a WIS2 Node,link=images/add-wis2node.png]
Once a WIS2 Node has been registered and connected to the Global Services, it can proceed to register the datasets it will publish via WIS2. To register a dataset, the WIS2 Node publishes discovery metadata about the new dataset. Validation of the discovery metadata is completed by the Global Discovery Catalogues, and the Global Brokers automatically subscribe to the topics provided in the discovery metadata record. For more information, see <<_1_3_2_how_to_provide_discovery_metadata_to_wis2>>.

Once the dataset has been successfully registered, the WIS2 Node can proceed to exchange data - see
<<_1_3_3_how_to_provide_data_in_wis2>>.
<<_1_3_3_how_to_provide_data_to_wis2>>.

When decommissioning a WIS2 Node, operators must ensure that obligations relating to data sharing within WIS continue to be met after the WIS2 Node is decommissioned, for example, by migrating the data sharing obligations to another WIS2 Node. In the case of a DCPC, this may mean transferring the responsibilities to another Member.

Expand Down Expand Up @@ -81,6 +81,7 @@ Access controls may be implemented for recommended data. Only the security schem
===== 2.6.2.1 Service levels and performance indicators

A WIS2 Node must be able to publish datasets and compliant discovery metadata. This entails:

* Publishing metadata to the Global Data Catalogue;
* Publishing core data to the Global Cache;
* Publishing data for consumer access;
Expand Down
2 changes: 1 addition & 1 deletion guide/sections/part3/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
== PART III
== PART III. Information management

include::information-management.adoc[]
Loading
Loading