diff --git a/documentation/_templates/_parts/navbar.html b/documentation/_templates/_parts/navbar.html index ae501ef3..8b8b82d8 100644 --- a/documentation/_templates/_parts/navbar.html +++ b/documentation/_templates/_parts/navbar.html @@ -8,11 +8,11 @@ - \ No newline at end of file + diff --git a/documentation/_templates/_parts/top-bar.html b/documentation/_templates/_parts/top-bar.html index 6c8e70a3..e925365f 100644 --- a/documentation/_templates/_parts/top-bar.html +++ b/documentation/_templates/_parts/top-bar.html @@ -3,8 +3,8 @@
- \ No newline at end of file + diff --git a/documentation/about/governance.md b/documentation/about/governance.md index ee504b41..0b78ad33 100644 --- a/documentation/about/governance.md +++ b/documentation/about/governance.md @@ -180,11 +180,11 @@ All notable changes are documented by Release via the [Changelog](https://github ### Deprecation Policy -If a term, such as a field title (known as a class or property in JSON schema) is scheduled to be renamed or removed as a result of the revision process, the next release must [deprecate](https://en.wikipedia.org/wiki/Deprecation) the term within the schema. The following MAJOR release must rename or remove the term from the schema, making it obsolete. Data that is published may use deprecated terms, but will receive warnings from the [360Giving Data Quality Tool](https://dataquality.threesixtygiving.org/). Once obsolete, terms in published data will be treated like any other non-Standard fields. +If a term, such as a field title (known as a class or property in JSON schema) is scheduled to be renamed or removed as a result of the revision process, the next release must [deprecate](https://en.wikipedia.org/wiki/Deprecation) the term within the schema. The following MAJOR release must rename or remove the term from the schema, making it obsolete. Data that is published may use deprecated terms, but will receive warnings from the [360Giving Data Quality Checker](https://dataquality.threesixtygiving.org/). Once obsolete, terms in published data will be treated like any other non-Standard fields. ### Support Policy -When a new version upgrade is made to the Standard, support will be offered for one prior version. Support in this context means that data published using this version is recognised as meeting the requirements of the Standard and will be accepted by the 360Giving Data Registry, Data Quality Tool and other tools managed by 360Giving that use 360Giving data. This means that deprecated terms are supported but obsolete terms are not. +When a new version upgrade is made to the Standard, support will be offered for one prior version. Support in this context means that data published using this version is recognised as meeting the requirements of the Standard and will be accepted by the 360Giving Data Registry, Data Quality Checker and other tools managed by 360Giving that use 360Giving data. This means that deprecated terms are supported but obsolete terms are not. Support for any earlier version than this will not be guaranteed when a new version is released. diff --git a/documentation/extensions/dei/prepare.md b/documentation/extensions/dei/prepare.md index 37172f19..b0d1463d 100644 --- a/documentation/extensions/dei/prepare.md +++ b/documentation/extensions/dei/prepare.md @@ -263,7 +263,7 @@ A key step to using the DEI Extension is declaring that you are using it in a ** This Meta sheet is the way 360Giving data publishers include metadata about their grants data in their files. It is separate and different from the metadata fields in the DEI Extension itself which are usually included in the main grants sheet. For further information read our guidance on 360Giving Data Standard [Metadata](../../technical/metadata.md#guide-to-including-metadata-in-spreadsheet-files). -It is only once you have declared that you are using the DEI Extension in the Meta sheet that your data can be checked and validated by the 360Giving [Data Quality Tool](https://dataquality.threesixtygiving.org/) and used by GrantNav and 360Insights. If you miss this crucial step, the Data Quality Tool will not recognise the fields for the DEI Extension and treat them as non-Standard [Additional Fields](../../technical/reference.md#additional-fields). +It is only once you have declared that you are using the DEI Extension in the Meta sheet that your data can be checked and validated by the 360Giving [Data Quality Checker](https://dataquality.threesixtygiving.org/) and used by GrantNav and 360Insights. If you miss this crucial step, the Data Quality Checker will not recognise the fields for the DEI Extension and treat them as non-Standard [Additional Fields](../../technical/reference.md#additional-fields). Once you have a Meta sheet in your file, you can declare the extension by adding the Metadata field with the title \`Extensions\`. Usually this is in column A. In the next column (usually column B), add the value **dei** @@ -291,9 +291,9 @@ It is straightforward to implement the DEI Extension into an existing JSON forma If you're updating an existing publication and your current version is **1.0** or greater, you can declare **1.4** without any problems related to backwards incompatibility (see also: our [Versioning and Upgrade Process](../../about/governance.md#versioning-and-upgrade-process)). - If you don’t have a **version** field currently, it is safe to add this with the value of **1.4** unless your data isn’t conformant to Version **1.0** or later. You can verify this by checking the 360Giving Data Standard data in your file in the [Data Quality Tool (DQT)](https://dataquality.threesixtygiving.org/), as all data that passes the tool’s validation checks is conformant with Version 1.0 or later. + If you don’t have a **version** field currently, it is safe to add this with the value of **1.4** unless your data isn’t conformant to Version **1.0** or later. You can verify this by checking the 360Giving Data Standard data in your file in the [Data Quality Checker](https://dataquality.threesixtygiving.org/), as all data that passes the tool’s validation checks is conformant with Version 1.0 or later. -2. Create the **extensions** field in your package data if you have not already done so, and add the string **dei**. This declares the extension to tooling such as the Data Quality Tool so you can validate the contents of the extension fields. +2. Create the **extensions** field in your package data if you have not already done so, and add the string **dei**. This declares the extension to tooling such as the Data Quality Checker so you can validate the contents of the extension fields. 3. For each grant that will contain DEI information, add a **grants.deiDetails** property. 1. When a grant has a **deiDetails** property, **deiDetails.leadership**, **deiDetails.mission**, and **deiDetails.project** become required for that grant. diff --git a/documentation/extensions/index.md b/documentation/extensions/index.md index 1984b9f3..047a2025 100644 --- a/documentation/extensions/index.md +++ b/documentation/extensions/index.md @@ -2,9 +2,9 @@ The [360Giving Data Standard](https://standard.threesixtygiving.org/en/latest/about/) is a uniform and consistent way to describe grantmaking data. It consists of a set of information fields that must be included when a grantmaking organisation shares grant data. Organisations publishing grant information using the Standard use the same formatting so the data can be easily understood, collated and compared by anyone. Data published using the 360Giving Data Standard can be located and ‘read’ easily by different applications and machines, including 360Giving’s own tools [GrantNav](https://grantnav.threesixtygiving.org) and [360Insights](https://insights.threesixtygiving.org). -360Giving data publishers may sometimes wish to collect and publish information which is not part of the 360Giving Data Standard. The Standard permits publishers to use any number of “additional fields“ in their data to meet their needs, but these additional fields are not recognised by the Standard. This means that they cannot be validated using tools such as the [Data Quality Tool](https://dataquality.threesixtygiving.org/) or used to filter data in GrantNav and 360Insights, and different publishers including the same kind of information may struggle to coordinate around how to name and structure this additional data. Read our guidance on [Additional fields](../technical/reference.md#additional-fields). +360Giving data publishers may sometimes wish to collect and publish information which is not part of the 360Giving Data Standard. The Standard permits publishers to use any number of “additional fields“ in their data to meet their needs, but these additional fields are not recognised by the Standard. This means that they cannot be validated using tools such as the [Data Quality Checker](https://dataquality.threesixtygiving.org/) or used to filter data in GrantNav and 360Insights, and different publishers including the same kind of information may struggle to coordinate around how to name and structure this additional data. Read our guidance on [Additional fields](../technical/reference.md#additional-fields). -**Extensions** to the 360Giving Data Standard are a way to address some of the issues with additional fields by introducing new optional fields and structures into 360Giving data. Each extension formally defines fields, structures, and rules which can then be recognised by tooling such as the Data Quality Tool which allows the data using extensions to be validated, and also provides further standardisation which supports interoperability between different datasets. +**Extensions** to the 360Giving Data Standard are a way to address some of the issues with additional fields by introducing new optional fields and structures into 360Giving data. Each extension formally defines fields, structures, and rules which can then be recognised by tooling such as the Data Quality Checker which allows the data using extensions to be validated, and also provides further standardisation which supports interoperability between different datasets. Extensions also address the issue of trying to support different use cases of 360Giving data whilst maintaining the stability and integrity of the Standard. A set of fields and features may be important to a significant portion of the 360Giving publishing community while there may not be enough demand to warrant adding the feature to the core set of Standard fields. Developing these features as an Extension can meet the needs of the community in a much shorter timescale, as well as providing a way to test out how the features work in practice. It is possible that an extension to the 360Giving Data Standard may later be integrated into the core Standard. diff --git a/documentation/footer.json b/documentation/footer.json index 5c65f75c..9ce53d1a 100644 --- a/documentation/footer.json +++ b/documentation/footer.json @@ -34,8 +34,8 @@ "description": "" }, { - "url": "https://data.threesixtygiving.org/", - "title": "Data Registry", + "url": "https://qualitydashboard.threesixtygiving.org", + "title": "360Giving Quality Dashboard", "description": "" }, { @@ -104,9 +104,9 @@ "description": "A uniform and consistent way to describe grants data. Publishing data in this standard format means it\u2019s easier to find, understand and compare funding across the UK." }, { - "url": "https://data.threesixtygiving.org/", - "title": "Registry", - "description": "A list of all the organisations that currently publish their grants data in the 360Giving Data Standard, with direct links to their data sources." + "url": "https://qualitydashboard.threesixtygiving.org", + "title": "360Giving Quality Dashboard", + "description": "A dashboard showing the data quality of 360Giving data as a whole and for each individual publisher. It provides insights into the key features that make the data useful for analysis to help publishers to identify opportunities for their data to be improved." } ] } diff --git a/documentation/guidance/before-starting.md b/documentation/guidance/before-starting.md index 02bf840c..08ef0929 100644 --- a/documentation/guidance/before-starting.md +++ b/documentation/guidance/before-starting.md @@ -37,7 +37,7 @@ Normally these planning steps only need to happen once, when publishing data for ### Prepare - If you haven’t published 360Giving data before, fill out the Publisher Registration Form to receive your 360Giving Publisher prefix and decide what file format to use for publishing your grant information. - Transform your grants data into 360Giving data using the correct data formatting and headings. -- Use the 360Giving Data Quality Tool along with this guidance to check if your data is ready to be published. +- Use the 360Giving Data Quality Checker along with this guidance to check if your data is ready to be published. For many publishers, preparing their data is a manual process that involves exporting information from a grants management system and converting it into 360Giving data in a spreadsheet file. You can use specially developed templates that take care of the technical aspects of transforming your grants data into the right format. Depending on the grants management system you use it might be possible to build in some or all of the steps needed to convert the information, so it can be exported directly from the system in 360Giving data format. diff --git a/documentation/guidance/cf-guidance.md b/documentation/guidance/cf-guidance.md index cf40d162..2030c7de 100644 --- a/documentation/guidance/cf-guidance.md +++ b/documentation/guidance/cf-guidance.md @@ -202,7 +202,7 @@ Save the file to your local drive as an .xlsx file. To do this click on ‘Save ## Check data quality and receive feedback Once you have exported a file of your data using the 360Giving extract, the next step is to check that the data is valid. Valid data means the file includes all the required fields and the information has the correct formatting. -Each Community Foundation is responsible for the data it publishes. You can check that your data is valid using this Data Quality Tool developed, which will tell you if there are any issues with your dataset. +Each Community Foundation is responsible for the data it publishes. You can check that your data is valid using this Data Quality Checker developed, which will tell you if there are any issues with your dataset. See the guidance on [checking data quality](../../guidance/data-quality/) before publishing your data. diff --git a/documentation/guidance/data-quality.md b/documentation/guidance/data-quality.md index ad2ffc0d..7f5735f0 100644 --- a/documentation/guidance/data-quality.md +++ b/documentation/guidance/data-quality.md @@ -15,12 +15,12 @@ The term ‘valid‘ means the file includes the 10 core fields, and the informa Only valid 360Giving data can be combined with other published data and be included in 360Giving tools, such as GrantNav and GrantVis. -## How to use the 360Giving Data Quality Tool -The Data Quality Tool (DQT) has been specially designed to support the preparation and publication of 360Giving data. +## How to use the 360Giving Data Quality Checker +The Data Quality Checker (DQT) has been specially designed to support the preparation and publication of 360Giving data. You can use it by uploading a file or providing a link to a file that is hosted online. - + ### Error message If you get an error message that the DQT can’t process your data, try again using a different file format. @@ -31,7 +31,7 @@ The acceptable files are spreadsheets in OpenDocument Spreadsheet (.ods), Excel  -## Understanding the Data Quality Tool feedback +## Understanding the Data Quality Checker feedback Once you have submitted your file, the screen will display feedback on key information points about the data, divided into up six tabs depending on the results: Summary, Additional Fields, Conversion errors, Validity, Accuracy and Usefulness. Explore the individual tabs view the feedback in detail. @@ -231,14 +231,14 @@ Other conversion errors are usually caused by the data not being formatted corre ### Getting more help -Please contact the 360Giving Helpdesk viaFind out more about what to check before publishing your data openly in our data protection guidance.
-### About Data Quality Tool security -The Data Quality Tool has been designed to support people preparing their 360Giving data, meaning the data inputted into it is in varying stages of readiness. +### About Data Quality Checker security +The Data Quality Checker has been designed to support people preparing their 360Giving data, meaning the data inputted into it is in varying stages of readiness. The feedback report you receive has a private URL, which means only those with the link can access the page and the data. If your data is not suitable for sharing publicly, then you should treat this URL with care and only share it with people who are allowed access to the data. As long as you do not put the URL on a public page, then it will not be possible for people to come across it by accident. -The files are deleted automatically from the Data Quality Tool after seven days. Read the Terms and Conditions for further details about how the files are stored and deleted. +The files are deleted automatically from the Data Quality Checker after seven days. Read the Terms and Conditions for further details about how the files are stored and deleted. ### What‘s next? Read our guidance about publishing your grant data openly to make it available for anyone to download and use. diff --git a/documentation/guidance/making-updates.md b/documentation/guidance/making-updates.md index d9f2ce52..b9234acb 100644 --- a/documentation/guidance/making-updates.md +++ b/documentation/guidance/making-updates.md @@ -40,7 +40,7 @@ This process is only possible if you do not make changes to your data to get it If you make changes to your data after exporting it from your system - for example changing description text to make it suitable for publishing openly – then you will need to produce a report to cover only the recently awarded grants and then incorporate the data into the existing file. -Once the data is ready and it has passed the [Data Quality Tool](../../guidance/data-quality) checks you can either: +Once the data is ready and it has passed the [Data Quality Checker](../../guidance/data-quality) checks you can either: - Add the new grant data into the existing file of published data and re-upload the file to your website. If you can keep the file name and the position of the file the same following an update it will mean the link from the Data Registry to your data will stay the same – so your updates will automatically get picked up in our system. - Upload a new file alongside your existing file, add a link to the file from your hosting page and let the 360Giving Helpdesk know about the new file. diff --git a/documentation/guidance/prepare-data.md b/documentation/guidance/prepare-data.md index c3c23e91..32c7e89e 100644 --- a/documentation/guidance/prepare-data.md +++ b/documentation/guidance/prepare-data.md @@ -6,7 +6,7 @@