Skip to content

docs: include update and deploy info in README #172

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

Open
robredpath wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: include update and deploy info in README #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion IATI-Developer-Documentation
Open in desktop
Submodule IATI-Developer-Documentation updated 2 files
+3 −3 .github/workflows/CI.yml
+2 −2 requirements.txt
2 changes: 1 addition & 1 deletion IATI-Guidance
Open in desktop
Submodule IATI-Guidance updated 3 files
+3 −3 .github/workflows/CI.yml
+2 −2 en/related-documents.rst
+2 −2 requirements.txt
2 changes: 1 addition & 1 deletion IATI-Upgrades
Open in desktop
Submodule IATI-Upgrades updated 2 files
+3 −3 .github/workflows/CI.yml
+2 −2 requirements.txt
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- `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"

Loading