ODI AU localisation

[Stephen-Gates]

This PR adds a localisation for Australia

Changes proposed in this pull request:

• add AU jurisdiction
• add AU localisation

We have had issues with testing locally:

• Some changes to the XML are reflected in the user interface, while others aren't - sometimes within the one question.
• The server has stopped reading CKAN metadata

We would like this change to be installed in Staging so we can test there and hopefully discover that the issue is our local server rather than the XML file.

If you are installing the xml file, for the first time then you will need to generate the corresponding ruby and yaml files using:

docker-compose exec web bundle exec rake surveyor:generate[AU]

Once completed you should now see corresponding '.rb' and '.yml' files created in surveys/generated/surveyor/ and surveys/generated/translations/

Once the '.rb' file has been generated, build the questionnaire:

docker-compose exec web bundle exec rake surveyor:build_changed_survey FILE=surveys/generated/surveyor/odc_questionnaire.AU.rb

The certificate should be installed and ready for testing.

We've added links to local certificate help https://theodi.org.au/open-data-certificate-help/. Some of this content needs to be updated and we'll do so in the near future.

cc @mattRedBox @ldodds @olivierthereaux

[olivierthereaux]

Had a chance to look at it now and it looks good. One question however - and possibly a stupid one - if there are rake tasks necessary to make this new localisation work, shouldn't it be specificed somewhere in one of the commits?

[Stephen-Gates]

Thanks @olivierthereaux, I'll have to get @mattRedBox to answer that. I hand-crafted the XML but Matt helped with the commands to generate the files. I thought I had to provide the XML then you would run the commands on your side. We can run the commands here and submit the generated files if that makes sense.

I can see that the certificate is still Alpha so the odc_questionnaire.AU.rb file was not updated.

I can also see that there is no questionnaire.jurisdiction.AU.yml file in the translations folder.

The commands provided above generate/update these two files from the XML.

Matt, from what you understand of the code, does it make sense for us to provide the generated files or should they be created ODIHQ server?

[Stephen-Gates]

I notice that when James Smith helped me with a prior attempt in 2016 that he submitted the generated .yml and .rb files so maybe that's ok.

My only concern was that when we generated the files on our server that only some of the changes were reflected in the certificate on screen so I thought it would be safer to generate on the ODIHQ server.

[ghost]

Hi @Stephen-Gates, @olivierthereaux I guess it shouldn't matter in theory, but there are likely differences between our server setups (as ours was brought up for development use). I'm not sure I've fully understood your question @olivierthereaux about the task instructions (but certainly not a stupid question), but if I've understood correctly, these rake tasks are not instructions we've introduced, they're part of the codebase and from what I saw were always an instruction to run manually against the existing server - there's the likely possibility that there are nuances in our temporary setup that might not exactly match what you have in your production (and more stable) server. To me, it makes more sense to generate theses files against the server which would also host the files, for the sake of keeping consistency. However, if needed, we can certainly generate the ruby and yaml files on our side, if you like (but again I think it would be better to do so against the ODIHQ server) , but the build task obviously needs to be performed on the ODIHQ server, as this involves transactions with the db.

[Stephen-Gates]

Thanks @mattRedBox

[Stephen-Gates]

I notice that the questionnaire for Canada was submitted as XML only and then files generated by the Labs team.

[olivierthereaux]

Thanks both - please bear with me as I'm still trying to find my way through a relatively sparse documentation. I just found this wiki page, which I find really hard to parse but may have the answers we need.

[olivierthereaux]

Echoing email sent today - is there any chance @Stephen-Gates @mattRedBox you could try and run the rake tasks mentioned in the wiki pages. My suspicion is that the tasks merely transform the XML into .rb and associated yml files, and don't need to be created in production, but in any working instance.

If you can generate the .rb and .yml (into https://github.com/theodi/open-data-certificate/tree/staging/surveys/generated) and create a PR for that I'm hoping this will complete the update.

[ghost]

That's correct Olivier - as I mentioned earlier the generate task we can do if you're concerned about it, but for reasons I mentioned earlier, it would be preferable to run against the current software. The build task needs to be performed on your server. Matt

On Wed, Jun 13, 2018 at 8:26 AM, Matthew Mulholland < matt@redboxresearchdata.com.au> wrote:

That's correct Olivier

On Tue, Jun 12, 2018 at 7:44 PM, Olivier Thereaux < notifications@github.com> wrote:

Echoing email sent today - is there any chance @Stephen-Gates https://github.com/Stephen-Gates @mattRedBox https://github.com/mattRedBox you could try and run the rake tasks mentioned in the wiki pages. My suspicion is that the tasks merely transform the XML into .rb and associated yml files, and don't need to be created in production, but in any working instance.

If you can generate the .rb and .yml (into https://github.com/theodi/open -data-certificate/tree/staging/surveys/generated) and create a PR for that I'm hoping this will complete the update.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/theodi/open-data-certificate/pull/1679#issuecomment-396531233, or mute the thread https://github.com/notifications/unsubscribe-auth/AFOooWDAIvXs7U_4Fxbf5S8ehgT0F-b8ks5t741_gaJpZM4UappC .