diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74d6ca8cb..2e653a09e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,7 +106,7 @@ To contribute contents such as blog posts, visualisations, and documentation, pl ### Blog post -- [Guide on contribute blog posts](https://dataviz.shef.ac.uk/docs/22/03/2020/contribute-blog-post) +- See the guide for how to contribute blog post on [website](https://dataviz.shef.ac.uk/docs/22/03/2020/contribute-blog-post) or [local markdown file](./content/docs/2020-03-22-datavizhub-guide/index.mdx). ### Documentation @@ -121,7 +121,7 @@ All markdown files and resources for the document should be placed under the dir ### Visualisation -- [How to contribute visualisation?](https://dataviz.shef.ac.uk/docs/21/07/2021/Contribute-visualisation) +- See the guide for how to contribute visualisation on [website](https://dataviz.shef.ac.uk/docs/21/07/2021/Contribute-visualisation) or [local markdown file](./content/docs/2021-07-21-Contribute-visualisation/index.mdx). [coc]: https://github.com/researchdata-sheffield/dataviz-hub2/blob/master/CODE-OF-CONDUCT.md [issue]: https://github.com/researchdata-sheffield/dataviz-hub2/issues @@ -131,4 +131,22 @@ All markdown files and resources for the document should be placed under the dir ### Styles -Place global variables in the file `src/css/_variables.scss` and use it in any scss files like `var.$varibale-name`. \ No newline at end of file +Place global variables in the file `src/css/_variables.scss` and use it in any scss files in the format of `var.$varibale-name`. + +You may wish to use the [react-reveal](https://www.react-reveal.com/) package to add some animations to your contributed pages. Sometimes the following order of HTML elements would not render the content correctly: + +```mdx +import { Fade } from "react-reveal"; + +
+ ...contents +
+``` + +To solve this problem, move the `` tag one level above: + +```mdx + +
...contents
+
+``` diff --git a/content/docs/2020-07-04-LearningPath-Lab/index.mdx b/content/docs/2020-07-04-LearningPath-Lab/index.mdx index 3e0d0320c..23c9c42cb 100644 --- a/content/docs/2020-07-04-LearningPath-Lab/index.mdx +++ b/content/docs/2020-07-04-LearningPath-Lab/index.mdx @@ -58,7 +58,7 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti"; Introduction @@ -66,7 +66,7 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti"; R @@ -74,7 +74,7 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti"; Python @@ -82,7 +82,7 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti"; Matlab @@ -130,8 +130,6 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti";
-{" "} -

R

@@ -468,8 +466,6 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti";
-{" "} -

Python

@@ -730,8 +726,6 @@ import { TiChevronLeft, TiChevronRight } from "react-icons/ti";
-{" "} -

Matlab

diff --git a/content/docs/2020-07-05-LearningPath-Workflow/index.mdx b/content/docs/2020-07-05-LearningPath-Workflow/index.mdx index a446f56f0..7314ea2f7 100644 --- a/content/docs/2020-07-05-LearningPath-Workflow/index.mdx +++ b/content/docs/2020-07-05-LearningPath-Workflow/index.mdx @@ -20,17 +20,17 @@ import { TiChevronLeft } from "react-icons/ti";
-
+
Learning Path - Workflow
-
+
Increase your research impact through reproducible data visualisation workflows.
-
Dataviz.Shef Team
+
Dataviz.Shef Team
-
+ +
- +{" "} + +
+

+ Reproducibility +

+

+ In computer science, reproducibility means that as long as the + environment and initial conditions are the same, when the program is + executed or the program is executed repeatedly, no matter if it is + executed from beginning to end without stopping, or "stop and restart" + execution, we will get the same result. Therefore, reproducibility + of data visualisation should follow the same principle.
+
+ Given the data and code provided (by an author) we should be able to get + the same output by following the same steps as the author does. But how do + we ensure that data and code are preserved and is accessible even after a + long period of time for further research or reference is important for + data visulisations as well as for publications. We hope you will find this + information useful and if you have any questions or have found any errors + in this page please contact us on our communication channels ( + email,{" "} + slack,{" "} + + google group + + ). +

+
+
-
- -

- Make yourself identifiable -

-

- Sometimes two researchers could have the same name or initials due to - culture differences and writing systems etc, it is important that - there is a mechanism for identifying who you are regardless where and - when you published articles, datasets, and make other contributions. - To resolve this problem, ORCID (Open Researcher and Contributor - ID) was introduced in 2012 that can{" "} - - provide a persistent digital identifier (an ORCID iD) that - distinguishes you from other researchers and a record that supports - automatic links among all your professional activities. Your{" "} - ORCID iD and connections are stored in the ORCID Registry, in - an account you own and manage - - . To register, visit{" "} - orcid.org. -

-
-
-
- -

- Make your data identifiable -

-

- Identifying datasets and codes is equally important to identify - yourself. DOI (digital object identifier) was introduced in - 2000 to identify many resources across academic, professional, and - government information, this will help you to include your datasets - and code within your publication through DOI. If other - researchers can easily locate your data and make use of it to - reproduce your work to make sense of your data and communicate - findings more widely. Read the{" "} - - next section - {" "} - to learn more about options of data repositories you can use. -

-
-
-
- -

- Deposit your data -

-

- For reproducibility purposes we advise you to deposit data and codes - in data repositories that can be accessed and cited by anyone{" "} - around the world through a unique DOI (digital object - identifier). For some repositories it is possible to use programming - languages like Python and R to fetch data directly from the source - using URL provided. If your data is not classified as sensitive data - and no discipline-specific repository is available, we encourage you - to deposit data and code in University's data repository (powered by{" "} - figshare) -{" "} - - Online Research Data (ORDA) - - . For other recommendations including discipline-specific - repositories, visit The University Library’s{" "} - - Research Data Repositories Page - - . -

-

If you have a GitHub account, check out the following articles:

- - - Citable code - - - Connect figshare with GitHub - - -

- There might be cases where your data comes from external sources like{" "} - data.gov.uk, don't forget acknowledge the source of the - information in your data and state the licence applied to. -

-

- We also encourage you not to limit to data visulisation and to visit - The University Library{" "} - - RDM page - {" "} - to give you a broad overview of Research Data Management at the - university and many specific guidances. -

-
-
-
-
-

+
+

+ Make yourself identifiable +

+

+ Sometimes two researchers could have the same name or initials due to + culture differences and writing systems etc, it is important that there is + a mechanism for identifying who you are regardless where and when you + published articles, datasets, and make other contributions. To resolve + this problem, ORCID (Open Researcher and Contributor ID) was + introduced in 2012 that can{" "} + + provide a persistent digital identifier (an ORCID iD) that distinguishes + you from other researchers and a record that supports automatic links + among all your professional activities. Your ORCID iD and + connections are stored in the ORCID Registry, in an account you own and + manage + + . To register, visit orcid.org. +

+
+ + +{" "} + +
+

+ Make your data identifiable +

+

+ Identifying datasets and codes is equally important to identify yourself.{" "} + DOI (digital object identifier) was introduced in 2000 to identify + many resources across academic, professional, and government information, + this will help you to include your datasets and code within your + publication through DOI. If other researchers can easily locate + your data and make use of it to reproduce your work to make sense of your + data and communicate findings more widely. Read the{" "} + + next section + {" "} + to learn more about options of data repositories you can use. +

+
+
+ +
+

+ Deposit your data +

+

+ For reproducibility purposes we advise you to deposit data and codes in + data repositories that can be accessed and cited by anyone around + the world through a unique DOI (digital object identifier). For + some repositories it is possible to use programming languages like Python + and R to fetch data directly from the source using URL provided. If your + data is not classified as sensitive data and no discipline-specific + repository is available, we encourage you to deposit data and code in + University's data repository (powered by{" "} + figshare) -{" "} + + Online Research Data (ORDA) + + . For other recommendations including discipline-specific repositories, visit + The University Library’s + Research Data Repositories Page + . +

+

If you have a GitHub account, check out the following articles:

+ + - Congratulations! -

{" "} - You have completed the learning path - Workflow, now you understand - the importance of the reproducible data visualisation workflow and also - able to deposit data and code in suitable data repositories. Note that we - are updating learning paths from time to time, so do keep eye on this - website and our community channels to get the latest information. -
+ Citable code + + + Connect figshare with GitHub + + +

+ There might be cases where your data comes from external sources like{" "} + data.gov.uk, don't forget acknowledge the source of the information + in your data and state the licence applied to. +

+

+ We also encourage you not to limit to data visulisation and to visit The + University Library{" "} + + RDM page + {" "} + to give you a broad overview of Research Data Management at the university + and many specific guidances. +

+
+ +
+
+

+ Congratulations! +

{" "} + You have completed the learning path - Workflow, now you understand the + importance of the reproducible data visualisation workflow and also able to + deposit data and code in suitable data repositories. Note that we are updating + learning paths from time to time, so do keep eye on this website and our + community channels to get the latest information. +
diff --git a/src/components/blog/postPagination.jsx b/src/components/blog/postPagination.jsx index d31b3b38b..aeae1d193 100644 --- a/src/components/blog/postPagination.jsx +++ b/src/components/blog/postPagination.jsx @@ -28,7 +28,7 @@ class PostPagination extends React.Component { let nextTitle = next ? shortenText(next.node.frontmatter.title, 6) : ""; let linkStyle = - "flex items-center px-3 hover:text-brand-blue text-gray-900 min-w-20"; + "flex items-center px-3 inline-block hover:bg-brand-blue text-brand-black"; return (
@@ -75,7 +75,7 @@ class PostPagination extends React.Component { data-tip="" data-for="share_editpost" > -
+
diff --git a/src/components/home/__tests__/__snapshots__/eventNotice.spec.js.snap b/src/components/home/__tests__/__snapshots__/eventNotice.spec.js.snap index 838050900..6b2f7aad4 100644 --- a/src/components/home/__tests__/__snapshots__/eventNotice.spec.js.snap +++ b/src/components/home/__tests__/__snapshots__/eventNotice.spec.js.snap @@ -54,7 +54,7 @@ Object {

@@ -114,7 +114,7 @@ Object { class="flex flex-wrap w-full md:w-1/6 content-center justify-center hidden-xs hidden-md" >
@@ -103,7 +97,7 @@ const eventNotice = ({ eventBrite }) => { href={node.url} target="_blank" rel="noopener noreferrer" - className="hidden group-hover:flex shadow-sm -mt-4 py-2 px-5 text-lg bg-gray-800 text-white hover:bg-brand-blue" + className="hidden group-hover:flex shadow-sm -mt-4 py-2 px-5 text-lg bg-brand-black text-white hover:text-brand-black hover:bg-brand-blue" > Register diff --git a/src/components/shared/__tests__/__snapshots__/search.spec.js.snap b/src/components/shared/__tests__/__snapshots__/search.spec.js.snap index e7b57c886..7037be4ea 100644 --- a/src/components/shared/__tests__/__snapshots__/search.spec.js.snap +++ b/src/components/shared/__tests__/__snapshots__/search.spec.js.snap @@ -18,7 +18,7 @@ exports[`Search component renders correctly 1`] = ` } >

What are you looking for?

@@ -136,7 +136,7 @@ exports[`Search component return search result without error 1`] = `
-

+

What are you looking for?

@@ -233,7 +233,7 @@ class Search extends Component { onChange={this.search} onInput={this.search} autoComplete="off" - className="search__input py-0 pl-4 text-lg focus:outline-none pr-5 text-gray-600" + className="search__input py-0 pl-4 text-lg focus:outline-none pr-5 text-gray-700" style={{ minWidth: "25vw" }} type="text" name="search" diff --git a/src/components/visualisation/__tests__/__snapshots__/visLayout.spec.js.snap b/src/components/visualisation/__tests__/__snapshots__/visLayout.spec.js.snap index a369a3132..b541ba905 100644 --- a/src/components/visualisation/__tests__/__snapshots__/visLayout.spec.js.snap +++ b/src/components/visualisation/__tests__/__snapshots__/visLayout.spec.js.snap @@ -6,14 +6,14 @@ Object { "baseElement":
@@ -583,7 +583,7 @@ Object { class="flex w-full h-full justify-center" >
, "container":
@@ -1260,7 +1260,7 @@ Object { class="flex w-full h-full justify-center" >
Test Tag 1 @@ -41,7 +41,7 @@ Object { , "container":
Test Tag 1 diff --git a/src/css/react-tabs.scss b/src/css/react-tabs.scss index 38e21cb67..b92d0e199 100644 --- a/src/css/react-tabs.scss +++ b/src/css/react-tabs.scss @@ -17,8 +17,8 @@ cursor: pointer; color: rgb(189, 189, 189); background-color: rgba(31, 41, 55, 1); - font-size: .95rem; - transition: .3s ease; + font-size: 0.95rem; + transition: 0.3s ease; &--selected { background: rgba(55, 65, 81, 1); @@ -26,7 +26,7 @@ border-bottom: 2px solid var.$colour-brand-blue; &:hover { - background: rgba(255,255,255, 1); + background: rgba(255, 255, 255, 1); color: black; } } @@ -38,7 +38,7 @@ &:hover { background: rgba(55, 65, 81, 1); - color: white + color: white; } &:focus { @@ -49,12 +49,20 @@ &__tab-panel { display: none; - font-size: .95rem; + font-size: 0.95rem; color: rgba(209, 213, 219, 1); - background-color: rgba(17, 24, 39, 1); + background-color: var.$colour-brand-black; &--selected { display: block; } + + a { + color: var.$colour-brand-blue; + + &:hover { + background: var.$colour-brand-purple; + } + } } } diff --git a/src/pages/about.jsx b/src/pages/about.jsx index a69bd7039..50ac00523 100644 --- a/src/pages/about.jsx +++ b/src/pages/about.jsx @@ -51,7 +51,7 @@ const About = () => {
- @@ -100,7 +100,7 @@ const About = () => {
-

Contribute

+

+ Contribute +

From ideas to content for the ORDA showcase, our blog or Dataviz