Skip to content

Commit

Permalink
docs: fix missing images in contribute visualisation docs
Browse files Browse the repository at this point in the history
Rewrite contributing guidelines.
Add submit issue button to the footer.
  • Loading branch information
yld-weng committed Jul 23, 2021
1 parent 2131485 commit a404f48
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 8 deletions.
35 changes: 31 additions & 4 deletions CONTRIBUTING.md
@@ -1,8 +1,25 @@
## Contribute blog post
To contribute, please visit the [guide](https://dataviz.shef.ac.uk/docs/22/03/2020/contribute-blog-post) for more information, if you have any questions raise an [issue](https://github.com/researchdata-sheffield/dataviz-hub2/issues) under this repository.
# Contributing to Dataviz.Shef
This is your community around interactive data visualisation at TUoS and we would love to have your contribution anytime. Please see the following guidelines for contributors:

- [Code of Conduct](#coc)
- [Issues, Bugs, Feedback!](#issue)
- [Commit Message Guidelines](#commit)
- [Contribute to the core website](#website)
- [Contribute blog posts](#blogpost)


## <a name="coc"></a> Code of Conduct
We has adopted a Code of Conduct that we expect participants to adhere to. Please read the [full text][coc] so that you can understand what actions will and will not be tolerated.


## <a name="issue"></a> Issues, Bugs, Feedback!
If you have found an issue or bug, or have any feedback regarding the website, please [submit an issue][issue] to help the community become even better. If you know how and would like to fix the problem, you can [create pull requests][pr] to submit a fix!


## <a name="commit"></a> Commit Message Guidelines
To help us keep a consistent and readable commit messages, we use the specification published on [Convention Commits](https://www.conventionalcommits.org/en).

## Contribute to the website
## <a name="website"></a> Contribute to the core website
This website is built from <a href="https://www.gatsbyjs.org/">Gatsby</a> framework.

### Installation
Expand All @@ -28,4 +45,14 @@ This website is built from <a href="https://www.gatsbyjs.org/">Gatsby</a> framew
### Submit your code
Before submitting your code, serve the production build to check if the website is running fine. Always try to write test cases for new codes and use `npm run test` to check if all tests passed.

Whenever you want to submit new codes, create a new pull request and merge it into the `development` branch. **DO NOT** attempt to merge new code into the `master` branch directly.
Whenever you want to submit new codes, create a new pull request and merge it into the `development` branch. **DO NOT** attempt to merge new code into the `master` branch directly.


## <a name="blogpost"></a> Contribute blog post
To contribute, please visit the [guide](https://dataviz.shef.ac.uk/docs/22/03/2020/contribute-blog-post) for more information, if you have any questions raise an [issue](https://github.com/researchdata-sheffield/dataviz-hub2/issues) under this repository.



[coc]: https://github.com/researchdata-sheffield/dataviz-hub2/blob/master/CODE-OF-CONDUCT.md
[issue]: https://github.com/researchdata-sheffield/dataviz-hub2/issues
[pr]: https://github.com/researchdata-sheffield/dataviz-hub2/pulls
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions content/docs/2021-07-21-Contribute-visualisation/index.mdx
Expand Up @@ -283,7 +283,7 @@ if you wish to not display certain information, consider using the following att
```


### Open research
### Open Source
This community encourages an open research culture and adheres to the FAIR (findable, accessible, interoperable, reusable) principle. Therefore, it would be wonderful if you could include as many details about the visualisation as possible. You can choose to use the visualisation tab component, or simply write information in plain text.

#### Visualisation tabs
Expand Down Expand Up @@ -347,7 +347,7 @@ Copy the name of the folder you have created in previous steps into the box with

Once that's done, scroll to the bottom of the page and click `commit new file`. The webpage will then bring you to the new folder and you can now upload all other files in your local machine.

If all goes well, go to the repository's main page and open a pull request.
If all goes well, go to the repository's main page (by click `Code` on the top left) and open a pull request.

![Open PR](openPR.png)

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Expand Up @@ -22,7 +22,7 @@ export const data = [
},
{
"title": "Detail",
"content": `The <a href="https://nivo.rocks/radar/">radar</a> component is used for this visualisation. If you would like to try this component, <a href="https://reactjs.org/docs/add-react-to-a-website.html">add React to your website</a> and install nivo and radar using <code class="language-text">npm install @nivo/core @nivo/radar</code>.`
"content": `This visualisation is based on the map mentioned in the source tab. I have chosen five cities across UK including two cities from Yorkshire and the Humber area, in which "almost half of local areas in here have very high percentages of people who were hungry in January", as suggested by researchers. The <a href="https://nivo.rocks/radar/">radar</a> component is used for this visualisation. If you would like to try this component, <a href="https://reactjs.org/docs/add-react-to-a-website.html">add React to your website</a> and install nivo and radar using <code class="language-text">npm install @nivo/core @nivo/radar</code>.`
},
{
"title": "Code",
Expand Down
3 changes: 2 additions & 1 deletion src/components/shared/footer.jsx
Expand Up @@ -47,8 +47,9 @@ const Footer = React.memo(({className}) => {
<div className="sm:w-2/12 h-auto sm:mt-0 mt-8">
<div className="text-white text-md mb-2 font-bold">Collaboration</div>
<ul className="list-reset leading-normal">
<li><A_footer href="https://github.com/researchdata-sheffield/dataviz-hub2/issues">Submit an Issue or feedback</A_footer></li>
<li><A_footer href="https://github.com/researchdata-sheffield/dataviz-hub2">Github repository</A_footer></li>
<li><Link className={linkClasses} to="/docs/22/03/2020/contribute-blog-post">Contribute blog post</Link></li>
<li><Link className={linkClasses} to="/docs/22/03/2020/contribute-blog-post">Contribute blog posts</Link></li>
</ul>
</div>

Expand Down

0 comments on commit a404f48

Please sign in to comment.