From 64df6ad9ed10049e292f1e4c6558d33b952873db Mon Sep 17 00:00:00 2001 From: Rob Redpath Date: Mon, 15 Jun 2026 17:44:19 +0100 Subject: [PATCH] docs: include update and deploy info in README --- IATI-Developer-Documentation | 2 +- IATI-Guidance | 2 +- IATI-Upgrades | 2 +- README.md | 14 +++++++++++++- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/IATI-Developer-Documentation b/IATI-Developer-Documentation index 7557781c..3837da1a 160000 --- a/IATI-Developer-Documentation +++ b/IATI-Developer-Documentation @@ -1 +1 @@ -Subproject commit 7557781c1fc561a6cac7ee8601201b5e5455dffb +Subproject commit 3837da1a90927a6b9ef7f07ffed3e7b857be4c66 diff --git a/IATI-Guidance b/IATI-Guidance index c29746d0..a68ff41e 160000 --- a/IATI-Guidance +++ b/IATI-Guidance @@ -1 +1 @@ -Subproject commit c29746d079335eba5bce7bed4b1e7eaba47461a3 +Subproject commit a68ff41e49a88cd1c89f98024ac84328448f1b3d diff --git a/IATI-Upgrades b/IATI-Upgrades index 34e67d46..97cdf8fd 160000 --- a/IATI-Upgrades +++ b/IATI-Upgrades @@ -1 +1 @@ -Subproject commit 34e67d46e315ccea8a5ca49b60b0bb174465ba5f +Subproject commit 97cdf8fdd738d334c144956975c426ecb1d0d919 diff --git a/README.md b/README.md index 1140f3f1..50ef491c 100644 --- a/README.md +++ b/README.md @@ -32,4 +32,16 @@ This will create the following primary outputs within the repository: Some diagnostic files are also created as a result of the process, they include: - `class_dict.json`: A nested data structure showing the class names of HTML elements within each file. This is used to ensure classes from the HTML output will be appropriately styled on the IATI Standard Website. - `href_list.csv`: A spreadsheet of links used within the output HTML, to help avoid broken links. -- `unknown_words.csv`: A spreadsheet of words that a standard Python dictionary thinks may be misspelled to avoid typos. \ No newline at end of file +- `unknown_words.csv`: A spreadsheet of words that a standard Python dictionary thinks may be misspelled to avoid typos. + + +## To Update + +If you have updated the SSOT, then create a PR to pull the new version of the SSOT. Once merged, proceed to release. + +## To Release + +Run the [Make_release](https://github.com/IATI/IATI-Reference-Generator/actions/workflows/release.yml) workflow manually. Check the release and make it public if necessary. + +If deploying to the IATI Website, go to [the IATI Standard edit page](https://iatistandard.org/cms/pages/88/edit/), select the relevant release, and click "Update SSOT data" +