The IATI Technical Team will shortly be moving the content of the IATI Standard Reference site onto IATI’s main website: iatistandard.org/. This work is being delivered in line with the IATI Workplan Y6 (Sept 2018 - Dec 2019) and IATI Workplan Y7 2020.
This move means that IATI Standard reference information will be accessible on one website, alongside other useful publisher and user content. It will also streamline the Technical Team’s process of updating content, saving valuable time.
What is changing?
IATI-Guidance GitHub repository removal - Currently the reference.iatistandard.org/ site displays content that is pulled from the IATI-Guidance GitHub repository. The IATI-Guidance GitHub repository will be removed and most of its content will be moved to Wagtail, which is the platform for IATI’s main website: iatistandard.org/.
Changelogs moved to IATI-Standard-SSOT GitHub repository - The only content from the IATI-Guidance GitHub repository that will not move to Wagtail is the changelogs. The changelogs will be moved into the IATI-Standard-SSOT repository, where they can continue to be updated in the same way that they have been in the past.
Other content to be moved to from GitHub to Wagtail include:
- github.com/IATI/IATI-Extra-Documentation/ - Only overview pages within this repository will be removed from Github and migrated to Wagtail.
- github.com/IATI/IATI-Developer-Documentation/ - Developer documentation to be removed from Github and moved to Wagtail.
Changes to the format of the IATI-Extra-Documentation GitHub repository - please provide your views
The IATI-Extra-Documentation repository will remain on GitHub however the Technical Team proposes to change the way the pages are written (as described below). Currently the Technical Team uses reStructuredText (rst) format, with additional Sphinx markup. However the additional Sphinx markup added to the files can be a nuisance to read as code and can sometimes be confusing for human reading as well.
The Technical Team propose changing the format of these files into one of two options:
Change the files into JSON format with some embedded Jinja which would link to the example XML files. This would mean it would be easier for developers to obtain the Extra-Documentation content from the repository, and it would correspond with the format that is used by the IATI-Standard-Website.
Change the Extra-Documentation repository into XML formatted files. This would enable developers to easily read and convert the documentation to the required formats, whilst also remaining in a familiar and readable format, allowing for easy generation or amendment of content as necessary.
Feedback required: Please provide your preferred option or any other comments about this proposal by responding to this post or emailing: email@example.com.
Do note: that the Technical Team will keep sphinx branches in the IATI-Extra-Documentation GitHub repository after the format switch is made. If you wish to keep using them in that format, only a branch switch will be required. However if you wish to use the new format, your work will have to adapt to include them.
What is not changing?
The following content will be accessible on iatistandard.org but will remain on Github and not be moved to Wagtail:
- IATI-Codelists + IATI-Codelists-NonEmbedded. Content will remain as is in the Github repository, management process for content of codelists still follows.
- IATI-Extra-Documentation Codelist management
- github.com/IATI/IATI-Extra-Documentation Excluding overview pages (which is moving to Wagtail, as mentioned above), everything will remain in the Github repository.
Who will be affected by these changes? Should I do anything to prepare?
Developers who pull guidance content from Github repositories into their own platforms may be affected. If a developer has concerns about the content in the Github repositories that will be moved to Wagtail, please contact the IATI Technical Team: firstname.lastname@example.org.
If you are not constantly creating guidance pages from the content of the IATI-Guidance or IATI-Extra-Documentation repositories, there’s nothing to prepare for.
Should I be aware of any potential difficulties with these changes?
After IATI Standard guidance moves from reference.iatistandard.org/ to iatistandard.org/, users will no longer be able to access new changes made to the content. Only changelogs will keep a record of new changes, and users will find the changelogs in the IATI-Standard-SSOT GitHub repository.
Will historic GitHub content be accessible to users?
Yes, historic content will still be available to users, as Github keeps control of commits over time.
Will there be French translations of the content moving from the IATI reference site to iatistandard.org?
The following content will be translated into French:
- Overview pages: Organisation Standard
- Overview pages: Activity Standard
- Codelists - The majority of codelists are already translated into French (They were translated in French in April 2018 with the support of the Government of Canada. Please note that if any codelists have been added since then, they may not be available in French.)
- Namespaces and extensions
The following content will be automatically generated from the IATI single source of truth, and will remain in English only:
When will these changes happen?
The proposed changes are scheduled to be implemented in early March. Github repositories deletion will only occur once the guidance is moved and deployed to iatistandard.org
Get in touch
If you have any questions about these changes please email email@example.com or post a comment below.
IATI Technical Team