Skip to content

Commit

Permalink
Merge pull request #165 from OCHA-DAP/docs/various-fixes-2
Browse files Browse the repository at this point in the history
More small read the docs fixes
  • Loading branch information
alexandru-m-g authored Jun 11, 2024
2 parents 2ed11f9 + b8f0c17 commit 5ba970f
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/data_usage_guides/affected_people.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Affected People

---

## Refugees & Persons of Concern <a id=”refugees”></a>

This dataset, compiled by [UNHCR](https://www.unhcr.org/), offers annual
Expand All @@ -24,7 +26,7 @@ For available query parameters, please see the
### Transformations applied

* The table has been reshaped from wide to long: demographic-specific columns
have been cast to gender, age, and population
have been cast to `gender`, `age_range`, and `population`
* It is not possible to p-code based on the location information in the
original data, therefore population numbers are aggregated to the national
level
Expand Down
2 changes: 2 additions & 0 deletions docs/data_usage_guides/coordination_and_context.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Coordination & Context

---

## Who is Doing What Where - Operational Presence <a id=”operational-presence”></a>

The [Who is Doing What Where (3W)](https://3w.unocha.org/) is a core
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@
- Parameter: '`location_ref`'
Description: >
A reference to the `id` of the associated entry in the `location` table
Source: '[`Location`](metadata.md#location)'
2 changes: 2 additions & 0 deletions docs/data_usage_guides/enums.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Enums

---

Enums, or enumerations, are a data type used to define a set of named values
that represent fixed options for a field in the API.

Expand Down
2 changes: 2 additions & 0 deletions docs/data_usage_guides/food_security_and_nutrition.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Food Security & Nutrition

---

## Food Security <a id="food-security"></a>

The [IPC Acute Food Insecurity (IPC AFI) classification](https://www.ipcinfo.org/ipcinfo-website/ipc-overview-and-classification-system/ipc-acute-food-insecurity-classification/en/)
Expand Down
2 changes: 2 additions & 0 deletions docs/data_usage_guides/metadata.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Metadata

---

## HDX Metadata

All of the data in HDX HAPI comes from publicly-available datasets on HDX, and
Expand Down
4 changes: 3 additions & 1 deletion docs/data_usage_guides/population_and_socio-economy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Population & Socio-economy

---

## Baseline Population <a id="population"></a>

The population statistics presented here are sourced from the
Expand All @@ -25,7 +27,7 @@ For available query parameters, please see the
### Transformations applied

* The table has been reshaped from wide to long: demographic-specific columns
have been cast to gender, age, and population
have been cast to `gender`, `age_range`, and `population`
* The reference period is obtained from the HDX dataset

### Usage Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

---

The [HDX Humanitarian API](https://dev.data-humdata-org.ahconu.org/hapi)(HDX HAPI) is a way to access standardised indicators from multiple sources to automate workflows and visualisations
The [HDX Humanitarian API](https://data.humdata.org/hapi)(HDX HAPI) is a way to access standardised indicators from multiple sources to automate workflows and visualisations

HDX HAPI is in beta phase, and we are seeking feedback. To share your thoughts or join our slack channel, send an email to [[email protected]]([email protected]).

Expand Down

0 comments on commit 5ba970f

Please sign in to comment.