IATI / validator-web

Front-End for the IATI Validator
https://validator.iatistandard.org/
GNU Affero General Public License v3.0
0 stars 1 forks source link

Update description text for validation statuses #599

Open robredpath opened 2 months ago

robredpath commented 2 months ago

@simon-20 after conversations in Bogotá I changed my mind about not updating the text in https://github.com/IATI/validator-web/blob/2de392f3bf667d7442c28da4ed1293354f407059/src/components/FileStatusInfo.vue - it clearly is more confusing than helpful.

I'll make a suggestion below - feedback welcome. @stevieflow @IsabelBirds @siwhitehouse in particular might have views on this.

(with appropriate links before we go live, obviously)


Validation includes testing the file against the IATI XML Schema and the IATI Rulesets. For more information, see IATI Validation Methodology

Success - file uses the IATI standard with no errors, warnings or advisories Success (with Advisories) - file uses the IATI standard with no errors or warnings, but there are ways that it could be more useful Warning - file passes XML schema validation, but does not pass all IATI rulesets that state that a condition "should" be met Error - file passes XML schema validation, but does not pass all IATI rulesets that state that a condition "must" be met Critical - data does not pass XML schema validation and therefore does not appear in the IATI Datastore and may be missing from other tools

IsabelBirds commented 2 months ago

Current messages for context

I think Critical should be made extra clear e.g.

Critical - Data does not pass XML schema validation. Data will not update in the IATI Datastore. Data may be unusable and/or missing from other tools.

robredpath commented 2 weeks ago

Let's go for:


This file has been tested against the IATI Standard XML Schema, and the IATI Standard Rulesets. For more information, see the documentation.

The validation statuses are:

Success - No errors, warnings or advisories Success (with Advisories) - No errors or warnings, but there are advisories relating to potential issues with the data Warning - XML Schema validation passes, but not all IATI ruleset rules stating that a condition "should" be met Error - XML schema validation passes, but not all IATI ruleset rules stating that a condition "must" be met Critical - XML schema validation fails. This means that data will not update in the IATI Datastore. Data may be unusable and/or missing from other tools.


@simon-20