Skip to content

Commit

Permalink
Merge pull request #259 from zimmerman-team/develop
Browse files Browse the repository at this point in the history
making changes to reflect IATI.cloud instead of IATI Datastore
  • Loading branch information
siemvaessen authored Jul 1, 2021
2 parents 6c413c0 + 25c7dc2 commit c6230d9
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 49 deletions.
28 changes: 14 additions & 14 deletions cypress/integration/about.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@
/// <reference types="cypress" />

const aboutHeadersText = [
'About the new Datastore',
'About IATI.cloud',
'What data can be accessed?',
'What can I do with the IATI Datastore?',
'Using the Datastore API',
'Using the Query Builder',
'What can I do with IATI.cloud?',
'Using the IATI.cloud API',
'Using the IATI.cloud Query Builder',
'In what formats can I output IATI data?',
];

const aboutParagraphs = [
'The new IATI Datastore offers a robust online data service, providing timely and standardised access to data published according to the IATI Standard. Data users can gain data on development and humanitarian resources and results through using the Datastore’s API. Users will also be able to download data from a new user-friendly Datastore Query Builder.',
'IATI.cloud offers a robust online data service, providing timely and standardised access to data published according to the IATI Standard. Data users can gain data on development and humanitarian resources and results through using the IATI.cloud API. Users will also be able to download data from a new user-friendly IATI.cloud Query Builder.',
/* ------------------- */
'The new IATI Datastore API provides data published by organisations who have used version 2 of the IATI Standard. This is following the decision to deprecate version 1 by IATI members, which was implemented July 2019.',
'The IATI.cloud API provides data published by organisations who have used version 2 of the IATI Standard. This is following the decision to deprecate version 1 by IATI members, which was implemented July 2019.',
/* ------------------- */
'To help users access good quality data, the Datastore will not hold any data that does not adhere to the IATI Schema. The IATI Schema provides the exact order and format that publishers should provide their XML files in. More information about the Schema can be found on IATI’s Reference site.',
'To help users access good quality data, IATI.cloud will not hold any data that does not adhere to the IATI Schema. The IATI Schema provides the exact order and format that publishers should provide their XML files in. More information about the Schema can be found on IATI’s Reference site.',
/* ------------------- */
'Depending on what information you are looking for and what questions you want to answer with IATI data, you can form queries and set up filters to get the details you require. You can do this via using the Datastore API or the Query Builder.',
'Depending on what information you are looking for and what questions you want to answer with IATI data, you can form queries and set up filters to get the details you require. You can do this via using the IATI.cloud API or the Query Builder.',
/* ------------------- */
'For detailed documentation on how to use the API, please refer to the Datastore API documentation. For information on how to map queries from the ‘old’ Datastore to the new one, please see the mapping document.',
'For detailed documentation on how to use the API, please refer to the IATI.cloud API documentation.',
/* ------------------- */
'The Query builder allows users to build common queries through a series of drop down and freetext filters.',
'The benefit of the IATI Datastore is that you can convert the original IATI data, provided in XML format, into two more formats - CSV and JSON. All data in the Datastore is filtered and output based on IATI activities. The exception is converting the data into CSV format, which also allows you to output it based on budgets and transactions.',
'The benefit of the IATI.cloud is that you can convert the original IATI data, provided in XML format, into three formats - CSV, JSON and XML. All data in IATI.cloud is filtered and output based on IATI activities. The exception is converting the data into CSV format, which also allows you to output it based on budgets and transactions.',
/* ------------------- */
'So, you can output:',
/* ------------------- */
'XML - The Datastore returns the original activity XML as published. This is enhanced with metadata, specifying the version of the IATI standard that individual activities were published at, as well as details of the query result.',
'CSV - The Datastore will convert the published XML data into CSV format. Only a subset of published data is present. This format can be used to analyse information using spreadsheet software such as Microsoft Excel or Libreoffice Calc.',
'XML: returns the original activity XML as published. This is enhanced with metadata, specifying the version of the IATI standard that individual activities were published at, as well as details of the query result.',
'CSV: convert the published XML data into CSV format. Only a subset of published data is present. This format can be used to analyse information using spreadsheet software such as Microsoft Excel or Libreoffice Calc.',
/* ------------------- */
'You can select the rows in a CSV file to represent individual activities, budgets or transactions depending on the output format you select. Each of these may be expanded by sector or country so that percentage splits can be analysed. Less technically adept users can use the Datastore CSV Query Builder tool to access data in this format.',
'You can select the rows in a CSV file to represent individual activities, budgets or transactions depending on the output format you select. Each of these may be expanded by sector or country so that percentage splits can be analysed. Less technically adept users can use the IATI.cloud CSV Query Builder tool to access data in this format.',
/* ------------------- */
'JSON - The Datastore will convert the published XML to JSON format. All the original published information is present in this alternative format. The same metadata that is given in the XML output is available in the JSON output.',
'JSON - IATI.cloud converts published XML to JSON format. All the original published information is present in this alternative format. The same metadata that is given in the XML output is available in the JSON output.',
];

describe('About', function () {
Expand Down
12 changes: 6 additions & 6 deletions cypress/integration/home.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
/// <reference types="cypress" />

const homeText: string[] = [
'IATI Datastore',
'IATI.cloud',
/* ------------------- */
'The IATI Datastore provides data on development and humanitarian spending and projects that address poverty and crises across the world.',
'IATI.cloud provides data on development and humanitarian spending and projects that address poverty and crises across the world.',
/* ------------------- */
'Find data published by organisations from governments, development finance institutions and UN agencies to NGOs, foundations and the private sector. They have published data according to the IATI Standard, our set of rules and guidance for sharing useful, open data.',
'Access data through using the Datastore’s API or Query Builder.',
'Access data through using the IATI.cloud API or Query Builder.',
/* ------------------- */
'About Datastore',
'About IATI.cloud',
/* ------------------- */
'The Datastore makes use of iati.cloud, an open-source native IATI data service developed by Zimmerman. IATI.cloud extracts and stores raw IATI XML files from the IATI Registry and makes it available as API endpoints to build data driven information solutions.',
'IATI.cloud is built as an open-source IATI data service developed by Zimmerman. IATI.cloud extracts and stores raw IATI XML files from the IATI Registry and makes it available as API endpoints to build data driven information solutions.',
/* ------------------- */
'Use the Query Builder to easily search IATI data based on selected filters and have it returned in spreadsheet (CSV or XLS), JSON and XML formats.',
'Use the Query Builder to easily search IATI data based on selected filters and have it returned in spreadsheet as a CSV file, JSON and XML formats.',
/* ------------------- */
'API Documentation',
/* ------------------- */
Expand Down
2 changes: 1 addition & 1 deletion public/data/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1844,7 +1844,7 @@
}
],
"_postman_id": "a571c294-861f-4286-b054-bcf61e1c5545",
"description": " Returns a list of IATI Activities stored in the IATI Datastore based on 10 results as a default. You can retrieve up to a 1.000 activities in a single call using the &page_size=[nr] option."
"description": " Returns a list of IATI Activities stored in IATI.cloud based on 10 results as a default. You can retrieve up to a 1.000 activities in a single call using the &page_size=[nr] option."
},
{
"name": "Activity-Transactions",
Expand Down
2 changes: 1 addition & 1 deletion public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
receiverUrl: 'https://rum-receiver.eu.sematext.com',
});
</script>
<title>IATI Datastore</title>
<title>IATI.cloud</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/datadisplay/DataTable/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export const DataTable = (props) => {
`}
>
<h3>
Datastore retrieved {props.allDataCount}{' '}
IATI.cloud retrieved {props.allDataCount}{' '}
{getRetrievedItemsLabel(rowFormat, props.allDataCount)} for you
</h3>
<Paper>
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/feedback/Banners/BannerNotice.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export const BannerNotice = () => (
<BannerElement1>
<BannerElement2>!</BannerElement2>
<BannerElement3>
The IATI Datastore is in a pre-launch phase; the date of an official
IATI.cloud is in a pre-launch phase; the date of an official
launch will be announced soon. If you find any issues please raise them on{' '}
<BannerElement4
href="https://github.com/zimmerman-zimmerman/iati.cloud/issues/new/choose"
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/feedback/Banners/CovidBanner/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export const CovidBanner = (props: CookieNoticeParams) => {
target="_blank"
rel="noreferrer"
>
IATI Datastore
IATI.cloud
</a>{' '}
does not contain data that is published in version 1 of the
Standard, or is published within a dataset which does not conform
Expand Down
2 changes: 1 addition & 1 deletion src/app/components/surfaces/Cards/ArticleCard/mock.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ArticleCardModel } from './model';

export const ArticleCardMock: ArticleCardModel = {
title: 'About Datastore',
title: 'About IATI.cloud',
description:
'IATI is a global initiative to improve the transparency of development and humanitarian resources and their results for addressing poverty and crises.',
buttonLabel: 'More',
Expand Down
2 changes: 1 addition & 1 deletion src/app/modules/about-module/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { AboutLayout } from './layout';
import { useTitle } from 'react-use';

function About() {
useTitle('IATI Datastore - About');
useTitle('IATI.cloud - About');
return <AboutLayout />;
}

Expand Down
42 changes: 21 additions & 21 deletions src/app/modules/about-module/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ export const Link = styled.a`
export const AboutLayout = () => {
return (
<PageContainer footer>
<ModuleHeader title="Using the IATI Datastore" />
<ModuleHeader title="Using IATI.cloud" />
<Box width="100%" height="40px" />
<Container maxWidth="lg">
<Grid container spacing={4}>
{/* Appbar component needs a refactor, therefore not in this PR.*/}
{/* INTRODUCTION */}
<Grid item lg={12}>
<Typography variant="h6" style={{ paddingBottom: '16px' }}>
About the new Datastore
About IATI.cloud
</Typography>
<ParagraphContainer data-cy="p0">
<Typography variant="body1" data-cy="body">
The new IATI Datastore offers a robust online data service,
IATI.cloud offers a robust online data service,
providing timely and standardised access to data published
according to the IATI Standard. Data users can gain data on
development and humanitarian resources and results through using
Expand All @@ -38,10 +38,10 @@ export const AboutLayout = () => {
href="https://iatidatastore.iatistandard.org/documentation"
target="_blank"
>
Datastore’s API
IATI.cloud API
</Link>
. Users will also be able to download data from a new
user-friendly Datastore Query Builder.
user-friendly IATI.cloud Query Builder.
</Typography>
</ParagraphContainer>
</Grid>
Expand All @@ -57,7 +57,7 @@ export const AboutLayout = () => {
href="https://iatidatastore.iatistandard.org/documentation"
target="_blank"
>
IATI Datastore API
IATI.cloud API
</Link>{' '}
provides data published by organisations who have used version 2
of the IATI Standard. This is following the decision to
Expand All @@ -74,7 +74,7 @@ export const AboutLayout = () => {

<ParagraphContainer data-cy="p2">
<Typography variant="body1">
To help users access good quality data, the Datastore will not
To help users access good quality data, IATI.cloud will not
hold any data that does not adhere to the IATI Schema. The IATI
Schema provides the exact order and format that publishers
should provide their XML files in. More information about the
Expand All @@ -89,24 +89,24 @@ export const AboutLayout = () => {
</Typography>
</ParagraphContainer>
</Grid>
{/* What can I do with the IATI Datastore? */}
{/* What can I do with IATI.cloud? */}
<Grid item lg={12}>
<Typography variant="h6" style={{ paddingBottom: '16px' }}>
What can I do with the IATI Datastore?
What can I do with IATI.cloud?
</Typography>
<ParagraphContainer data-cy="p3">
<Typography variant="body1">
Depending on what information you are looking for and what
questions you want to answer with IATI data, you can form
queries and set up filters to get the details you require. You
can do this via using the Datastore API or the Query Builder.
can do this via using IATI.cloud or the Query Builder.
</Typography>
</ParagraphContainer>
</Grid>
{/* Using the Datastore API */}
{/* Using the IATI.cloud API */}
<Grid item lg={12}>
<Typography variant="h6" style={{ paddingBottom: '16px' }}>
Using the Datastore API
Using the IATI.cloud API
</Typography>
<ParagraphContainer data-cy="p4">
<Typography variant="body1">
Expand All @@ -116,9 +116,9 @@ export const AboutLayout = () => {
href="https://iatidatastore.iatistandard.org/documentation"
target="_blank"
>
Datastore API documentation
IATI.cloud API documentation
</Link>
. For information on how to map queries from the ‘old’ Datastore
. For information on how to map queries from the ‘classic’ Datastore
to the new one, please see the{' '}
<Link
href="https://docs.google.com/document/d/1nTu1Jdg17toiQoemJT3R9YPwvAwCN1gpFnnL1R-lfHY/edit"
Expand Down Expand Up @@ -165,9 +165,9 @@ export const AboutLayout = () => {
</Typography>
<ParagraphContainer data-cy="p6">
<Typography variant="body1">
The benefit of the IATI Datastore is that you can convert the
original IATI data, provided in XML format, into two more
formats - CSV and JSON. All data in the Datastore is filtered
The benefit of IATI.cloud is that you can convert the
original IATI data, provided in XML format, into three
formats - CSV, XLM and JSON. All data in IATI.cloud is filtered
and output based on IATI activities. The exception is converting
the data into CSV format, which also allows you to output it
based on budgets and transactions.
Expand All @@ -180,7 +180,7 @@ export const AboutLayout = () => {

<ParagraphContainer data-cy="p8">
<Typography variant="body1">
XML - The Datastore returns the original activity XML as
XML - returns the original activity XML as
published. This is enhanced with metadata, specifying the
version of the IATI standard that individual activities were
published at, as well as details of the query result.
Expand All @@ -189,7 +189,7 @@ export const AboutLayout = () => {

<ParagraphContainer data-cy="p9">
<Typography variant="body1">
CSV - The Datastore will convert the published XML data into CSV
CSV - will convert the published XML data into CSV
format. Only a subset of published data is present. This format
can be used to analyse information using spreadsheet software
such as Microsoft Excel or Libreoffice Calc.
Expand All @@ -202,14 +202,14 @@ export const AboutLayout = () => {
activities, budgets or transactions depending on the output
format you select. Each of these may be expanded by sector or
country so that percentage splits can be analysed. Less
technically adept users can use the Datastore CSV Query Builder
technically adept users can use the IATI.cloud CSV Query Builder
tool to access data in this format.
</Typography>
</ParagraphContainer>

<ParagraphContainer>
<Typography data-cy="p11" variant="body1">
JSON - The Datastore will convert the published XML to JSON
JSON - IATI.cloud will convert the published XML to JSON
format. All the original published information is present in
this alternative format. The same metadata that is given in the
XML output is available in the JSON output.
Expand Down
2 changes: 1 addition & 1 deletion src/app/modules/documentation-module/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { DocumentationRoutes } from 'app/modules/documentation-module/routes';
import useTitle from 'react-use/lib/useTitle';

function DocumentationModule() {
useTitle('IATI Datastore - Documentation');
useTitle('IATI.cloud - Documentation');

return (
<StoreProvider store={docStore}>
Expand Down

0 comments on commit c6230d9

Please sign in to comment.