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.

Sign up for GitHub

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

Jump to bottom

Fix broken codelist reference URLs in schema #236

Merged
merged 3 commits into from
Sep 1, 2023
Merged

Fix broken codelist reference URLs in schema #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f76c80
schema/rdls_schema.json: Fix broken codelist reference URLs
duncandewhurst Aug 31, 2023
c7bfbd5
developer_docs.md: Add style guide for codelist field descriptions
duncandewhurst Aug 31, 2023
b4169bf
Update changelog
duncandewhurst Aug 31, 2023
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
12 changes: 12 additions & 0 deletions developer_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/about/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading
Loading