Merge branch 'dev' into 198-update-examples

GFDRR · Sep 1, 2023 · a74105b · a74105b
2 parents fa0cb0c + 6e1e50e
commit a74105b
Show file tree

Hide file tree

Showing 9 changed files with 265 additions and 181 deletions.
diff --git a/developer_docs.md b/developer_docs.md
@@ -230,6 +230,18 @@ To deploy the `dev` branch to the live documentation site, [create a pull reques
 
 ## Style guides
 
+### Schema style guide
+
+#### Field descriptions
+
+##### Codelists
+
+Use the following template, noting that any `_` characters in the codelist title need to be replaced with the `-` character in the codelist URL:
+
+```
+The <semantics>, from the <open|closed> [<codelist_title> codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#codelist-title).
+```
+
 ### Changelog style guide
 
 - Use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

diff --git a/docs/_static/extra.css b/docs/_static/extra.css
@@ -60,7 +60,9 @@ margin-bottom: 20px;
 margin-bottom: 20px;
 margin-right: 20px;
 }
-
+.wy-nav-content {
+  max-width: 1000px !important;
+}
 .wy-side-nav-search {
   background-color: #0b3860;
 }

diff --git a/docs/about/changelog.md b/docs/about/changelog.md
@@ -78,6 +78,10 @@ This page lists changes to the Risk Data Library Standard.
 - [#218](https://github.com/GFDRR/rdl-standard/pull/218) - `Vulnerability·taxonomy` removed from required array.
 - [#220](https://github.com/GFDRR/rdl-standard/pull/220) - Reorder top-level fields.
 - [#233](https://github.com/GFDRR/rdl-standard/pull/233), [#235](https://github.com/GFDRR/rdl-standard/pull/235) - Rename authorNames to `author_names`, datePublished to `date_published` and gazetteerEntries to `gazetteer_entries`.
+- [#232](https://github.com/GFDRR/rdl-standard/pull/232)
+  - Convert `disaster_identifiers` to array of `Classification` objects.
+  - Add new codes to classification_scheme.csv.
+- [#236](https://github.com/GFDRR/rdl-standard/pull/236) - Fix broken codelist reference URLs.
 
 ### Codelists
 
@@ -92,6 +96,7 @@ This page lists changes to the Risk Data Library Standard.
 - [#164](https://github.com/GFDRR/rdl-standard/pull/164) - replace camelCase codes with snake_case codes in 'frequency_distribution.csv' and 'seasonality.csv'
 - [#189](https://github.com/GFDRR/rdl-standard/pull/189) - add 'ISO 3166-1 alpha-3' to 'location_gazetteers.csv and 'generalized_extreme_value' to 'frequency_distribution.csv'
 - [#136](https://github.com/GFDRR/rdl-standard/issues/136)- add description for secondary_rupture.
+- [#214](https://github.com/GFDRR/rdl-standard/pull/214) - use consistent separators in `classification_scheme.csv` codes.
 
 ### Normative documentation
 
@@ -106,6 +111,7 @@ This page lists changes to the Risk Data Library Standard.
 - [#212](https://github.com/GFDRR/rdl-standard/pull/212) - Update diagrams, add descriptions for dataset, resource and risk components.
 - [#225](https://github.com/GFDRR/rdl-standard/pull/225) - Update high level descriptions of the 4 risk data components.
 - [#196](https://github.com/GFDRR/rdl-standard/pull/196) - Add examples to schema reference documentation.
+- [#214](https://github.com/GFDRR/rdl-standard/pull/214) - Improve display of codelist reference.
 
 ### Non-normative documentation
 

diff --git a/docs/rdl/other-standards.md b/docs/rdl/other-standards.md
@@ -14,11 +14,6 @@ In 2018 an international consortium led by the British Geological Survey develop
 In this standard, we developed a list of hazard type codes and process type codes which are used as a reference in the hazard, vulnerability and loss components of the standard, and facilitate matching of appropriate vulnerability functions to hazard data, for example.
 Details about the development are reported [here](https://riskdatalibrary.org/resources).
 
-**GLIDE disaster event identifier**:
-Since the beginning of 2004, GLobal IDEntifier numbers (GLIDE) are produced at (GLIDEnumber.net) for all new disaster events reported by partner institutions and those discovered by ADRC.
-A GLIDE number comprises two letters to identify the disaster type (e.g. EQ - earthquake); the year of the disaster; a six-digit, sequential disaster number; and the three-letter ISO code for country of occurrence. E.g., the GLIDE number for West-India Earthquake in India is: EQ-2001-000033-IND. This number is posted by the above organizations and in many other websites, on their documents relating to that particular disaster and gradually other partners will include it in whatever information they generate. As information suppliers join in this initiative, documents and data pertaining to specific events may be easily retrieved from various sources, or linked together using the unique GLIDE numbers. List of services using GLIDE: https://glidenumber.net/glide/public/links.jsp
-The RDL Standard uses a GLIDE number in the `hazard.event` object, to denote the historical event to which hazard event data relates, e.g., the simulated hazard intensity footprint of that event.
-
 ### Hazard taxonomies
 
 The RDL project performed a review of the most relevant hazard taxonomies and derived a classification focusing on those hazards and processes that are more often required in disaster risk assessments, while mapping and matching alternative definitions into one consistent framework. There are several existing taxonomies that could have been adopted to describe hazard data: