search

IATI / IATI-Codelists-NonEmbedded

IATI Codelists that are 'non-functional' and usually provide lookup information.
http://iatistandard.org/codelists/codelist-management/
Other
3 stars 19 forks source link

Update description text #252

Closed stevieflow closed 6 years ago

stevieflow commented 6 years ago

Re: #248 - make this clearer that this is managed / sourced by org-id

@amy-silcock @PetyaKangalova @dalepotter sorry, I missed this commit in the set of PRs that were originally sent through. Thanks to @andylolz for spotting!

andylolz commented 6 years ago

This looks fine

I don’t agree :( The travis build on this repo is good and useful! master is currently passing, but this PR is failing. So *this shouldn’t be merged as is*.

It appears to be complaining about the use of HTML tags in this description – I guess you can’t add links in this way.

andylolz commented 6 years ago

@amy-silcock You’re right to use RST instead of markdown, which you’ve already sorted.

But I think to stop the tag-like things being processed as XML, it’s necessary to wrap the text in one of these: <![CDATA[ and one of these: ]]> (reference).

So, something like this:

<narrative><![CDATA[
The values from this codelist are used to identify the particular list that an organisation identifier was drawn from. The codelist provides a register of known identifier lists, including national company registers, NGO directories and international and multilateral organisation lists - along with guidance and online resources to help locate the identifiers assigned to a specific organisation. 

As of 17 July 2017 this list is maintained by the org-id.guide project. Data publishers can now search for and locate the relevant list for a particular organisation identifier using the `org-id.guide website <http://org-id.guide/>`__. The full register of identifier sources is also available to download in `XML <http://org-id.guide/download.xml>`__, `JSON <http://org-id.guide/download.json>`__ and `CSV <http://org-id.guide/download.csv>`__ formats. 

IATI periodically replicates the codelist of identifier sources from org-id.guide, to assist those accessing IATI documentation. However, it is advised that the most up-to-date source is the c.

If org-id.guide does not contain an entry for the kind of organisation you need to identify, you can make a request a new list is included in the register following the `guidance <http://docs.org-id.guide/en/latest/contribute/>`__ or by getting in touch with org-id.guide at: contact@org-id.guide.
]]></narrative>
andylolz commented 6 years ago

I’m not sure why Travis says the PR is failing. It looks like it hasn’t re-run tests on the PR since the last successful commit (acffa059).

@stevieflow maybe you need to hit “Update branch” to force travis to re-run PR checks? Could you try that? Thanks!

andylolz commented 6 years ago

I’m not sure why Travis says the PR is failing

^^ Sorry, I was looking at the github web interface, and thought acffa05 was on this branch, but it isn’t (it just references this branch). So this PR is failing because it doesn’t include the <![CDATA[ and ]]> wrapper.

258 does include the wrapper, and looks fine to me (and tests pass).

andylolz commented 6 years ago

This PR should be closed in favour of #258.