Merge pull request #236 from GFDRR/161-codelist-anchors

Fix broken codelist reference URLs in schema
GFDRR · Sep 1, 2023 · 682e5b5 · 682e5b5
2 parents a4fd40a + b4169bf
commit 682e5b5
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 35 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/about/changelog.md b/docs/about/changelog.md
@@ -78,6 +78,7 @@ 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) - Rename authorNames to `author_names`, datePublished to `date_published` and gazetteerEntries to `gazetteer_entries`.
+- [#236](https://github.com/GFDRR/rdl-standard/pull/236) - Fix broken codelist reference URLs.
 
 ### Codelists