-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Website Restructure. #112
Merged
Merged
Website Restructure. #112
Changes from all commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
c21524e
Initial restructure
ninadicara a3d9269
Add individual hazard pages
ninadicara 03b30b6
Move contribution guidelines to website
ninadicara 5d847e7
Add examples of people using hazards
ninadicara dea2184
Standardise capitalisation on labels
ninadicara 1078949
Move contributors to main site and add Nina
ninadicara f2e18c7
Changes to contributing guidelines mostly done
ninadicara 6ff7b5c
New mailing list and coworking times
ninadicara 8edb982
Add mailing list to materials
ninadicara 553367c
Fix contributors TOC
ninadicara c69b56b
Make title bold
ninadicara c2b2003
Restructure and additions to materials
ninadicara fe4ee0f
Clarify source of CoC
ninadicara 334795f
Move unused files to misc
ninadicara c299c28
Add mailing list to bottom - admonition bug
ninadicara dcee5fd
Fix heading depth
ninadicara aa32f60
Update internal links
ninadicara 0d9ae90
Add about page detail
ninadicara d04f55c
Contributing update page titles
ninadicara 0e54e95
Updates to materials formatting
ninadicara 52c98ac
Formatting update to code snippet
ninadicara 4dc7323
Link fixes
ninadicara 04f147d
Update title
ninadicara 9db81ee
Link fixing
ninadicara 3e643c6
Update site/contents/about.md
ninadicara 17e058c
Update site/contents/contribute/changelog.md
ninadicara 076c4d5
Clarify wording
ninadicara f1edf6f
Merge branch 'mozfest-updates' of github.com:very-good-science/data-h…
ninadicara d590051
Improve spacing
ninadicara 305b3bb
Make 'self assessment' consistent no hyphen
ninadicara 22ffec8
Follow my own style guidelines...
ninadicara 88145c2
Minor wording and link fixes
ninadicara File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,6 @@ | ||
# Contributing | ||
[//]: # (TODO: Maybe move this to the website!) | ||
|
||
Thank you for being interested in contributing to this project! | ||
Your help is very valuable: to get a handle on the ethical implications of Data Science, we *need* to consider diverse viewpoints! | ||
|
||
## *Types* of contribution | ||
Here are some ways to get involved. We would absolutely love your input on the following: | ||
1. Feedback on our [Data Hazard Labels](https://very-good-science.github.io/data-hazards/contents/materials/workshop/data-hazards.html), we accept suggestions through Issues and Pull Requests✨ here on GitHub, or via [email][dec-email]. For example you might suggest: | ||
- Ways of rewording Data Hazard Label descriptions or titles. | ||
- New examples of Data Hazards. | ||
- New/updated "Safety Precautions" (ways of combatting Data Hazards). | ||
- Ideas for new Data Hazards. | ||
2. Join one of [upcoming workshops](https://very-good-science.github.io/data-hazards/contents/upcoming-events.html) or (in development) asynchonous mailing lists to provide Data Hazards reviews on different projects. | ||
3. Contribute to any of our [workshop materials](https://very-good-science.github.io/data-hazards/contents/exercises.html) - or ideas for new materials (open an issue or [email us][dec-email]). | ||
4. Use the Data Hazards materials to reflect on your own work and contribute this as an example to help other people use the | ||
5. Find [GitHub issue][issues] that you know how to solve, and help us with that! | ||
|
||
## *How* to contribute | ||
|
||
[//]: # (TODO: Have a guide here to the way that the website is organised) | ||
|
||
We will develop these contribution guidelines as we go, including where to look in this repo for different files and so on. | ||
For now, they are a little thin, so if you'd like to help please get in touch with us, please [send us an email][dec-email] and we will help you to find what you're looking for! | ||
|
||
### Contributing on GitHub | ||
If you find an [issue][issues] that you'd like to help with, then please: | ||
1. Comment on it before you start working, so we don't repeat work. | ||
2. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your own GitHub account | ||
3. Check that you are happy with the changes by [building the site locally](#build-the-site-locally). | ||
4. Then, once you've made your changes, submit a [pull request](https://help.github.com/articles/creating-a-pull-request): we'll review it as quick as we can 😄. | ||
|
||
### Adding slides | ||
We try to keep all our slides for Data Hazards on our website. | ||
|
||
The current process is: | ||
1. (Optional) create slides in powerpoint, upload to Google drive (which will convert it to Google slides) + check formatting (alternatively, create in Google slides) | ||
2. Create a new markdown web page. | ||
2. Publish google slides `File -> Publish to the web -> Embed -> Small` | ||
3. Copy and paste to new markdown web page. | ||
3. Make viewable with link `Share -> Anyone on the internet with this link can view` | ||
4. Add link to markdown web page. | ||
|
||
Recommendations for a process to create html slides that works with myst markdown extremely welcome! | ||
|
||
### Build the site locally | ||
In order to build the site locally, you'll need to run the following from your root directory: | ||
`sphinx-build site/ site/_build/` | ||
|
||
These require some Python packages to run. | ||
You may want to set up a [virtual environment](https://docs.python.org/3/library/venv.html) first, so that you don't install these packages system-wide. | ||
Then you can install the packages using `pip install -r requirements.txt` | ||
|
||
|
||
--- | ||
[issues]: https://github.com/very-good-science/data-hazards/issues | ||
[dec-email]: [email protected] | ||
Please see out full contributing guidelines on the website: |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# About | ||
|
||
## How the project started | ||
|
||
The Data Hazards project started 2021. | ||
We (Natalie and Nina) wanted a way to communicate what might go wrong in data science projects, because we were frustrated by the repetitive themes we were seeing in harmful technologies that we talked about in [Data Ethics Club](https://dataethicsclub.com). | ||
We were also concerned that many projects that have significant societal impact do not have those impacts scrutinised by an Ethics Committee, because they do not technically have research participants. | ||
After that conversation we came up with the idea of Hazard labels for communicating these potential harms, and called them Data Hazards. | ||
We decided they should be visual, like COSHH chemical hazards are, and that they should be a way for people at all stages of data science technology development to communicate about the same potential outcomes (no matter how far away those outcomes might seem). | ||
|
||
You can see [the current Data Hazard labels here](data-hazards). | ||
You can [read our original proposal here](materials/misc/proposal). | ||
|
||
The image below describes the 'anatomy' of a Data Hazards label. | ||
|
||
```{image} ../images/hazardanatomy.png | ||
:alt: An image of a orange square with a red hexagon in it and the words 'Title', 'Description', 'Examples', 'Safety precautions'. | ||
``` | ||
|
||
|
||
Once we had thought of the original list of Hazards we wanted a way for researchers to think about them in a format that encouraged them to reflect, invite different opinions and make them think more broadly about the potential ethical concerns from their project. | ||
This led to the development of our workshop format and [all the materials we have since made](materials) for self-reflection and teaching. | ||
All our resources are designed for re-use by others. | ||
|
||
|
||
## Ethos | ||
|
||
The Data Hazards are built on the foundations of [standpoint theory](https://en.wikipedia.org/wiki/Standpoint_theory). | ||
This is an epistemiological theory that knowledge (including in the sciences) is not objective, and that our perspectives are shaped by our lived socio-political experiences. | ||
This means that ethical problems are not going to have a single correct answer, and that to get a well-rounded understanding of the ethical issues of any new technology we need people from lots of different standpoints to analyse it from their perspective. | ||
This is the best way we can understand the harms it could possibly cause. | ||
We also need to make sure that we are paying attention to how technology might be more likely to adversely affect people from minoritised backgrounds. | ||
|
||
In summary, the Data Hazards exist to prompt discussion, reflection and thought. | ||
They are not a checkbox exercise, and there is no requirement for a group to come to a consensus. | ||
In an individual context you will likely come to a conclusion, but someone else may have a different view. | ||
We hope that the Data Hazards discussion and reflective activities will help researchers be aware of a broader variety of potential ethical risks in tech projects, and that ethics is complex, situational and worth discussing. |
4 changes: 2 additions & 2 deletions
4
site/contents/materials/code-of-conduct.md → site/contents/code-of-conduct.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Contributing | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
code-of-conduct | ||
contribute/style-guide | ||
contribute/how-to-contribute | ||
contribute/credit-for-contributions | ||
contribute/contributors | ||
contribute/changelog | ||
``` | ||
|
||
The Data Hazards project is always welcoming new contributors! | ||
This page gives you an overview of how you can get involved. | ||
You can see all of our wonderful existing contributors in our [Record of contributions](contribute/contributors). | ||
|
||
We strongly welcome first-time GitHub users and are very happy to provide support if you would like to learn how to edit the repository. | ||
Please just [get in touch by email][dec-email] if that is the case. | ||
You could also come to our [community co-working calls](events/coworking)! | ||
|
||
All our content is created and shared under a [CC-BY 4.0 license](https://creativecommons.org/licenses/by/4.0/), and so if you do contribute to the repository your work will also be shared under this license. | ||
|
||
--- | ||
|
||
## 1. Decide how you would like to contribute | ||
|
||
We would absolutely love your input on the following: | ||
|
||
1. General feedback on our [Data Hazard Labels](data-hazards), which you can send to us through email or on [GitHub Discussions](https://github.com/very-good-science/data-hazards/discussions/new?category=feedback). | ||
2. Suggestions for new Data Hazard labels, or changes to them. | ||
For example you might suggest: | ||
- Ways of rewording Data Hazard label descriptions or titles. | ||
- New examples of Data Hazards. | ||
- New/updated "Safety Precautions" (ways of combatting Data Hazards). | ||
- Ideas for new Data Hazards. | ||
3. Join one of [upcoming events](events) or (in development) asynchonous mailing lists to provide Data Hazards reviews on different projects. | ||
4. Contribute to [any of our materials](materials) or share ideas for new materials to help others use the Hazards. | ||
This could include: | ||
- Fixing a typo or a broken link. | ||
- Sharing a link to materials you have made. | ||
- Adding a written example of how you used the Hazards to our growing list. | ||
- Making additions or changes to the existing materials on the site. | ||
5. Use the Data Hazards materials to reflect on your own work and contribute this as an example to help other people use them. | ||
6. Find [GitHub issue][issues] that you know how to solve, and help us with that! | ||
|
||
## 2. Read our [Code of Conduct](code-of-conduct) and [Style Guide](contribute/style-guide) | ||
|
||
These documents are linked above and in the side bar. | ||
They are both short, but we ask that you have read them to ensure that we can make sure this community is a welcoming place, and that the content we create is consistent and easy to understand. | ||
|
||
## 3. Make your contribution | ||
|
||
The [How to contribute](contribute/how-to-contribute) guide gives you an overview of how you should approach different contribution types. | ||
|
||
## 4. Get credit | ||
|
||
The Data Hazards team are very keen to recognise all contributions people make to this project. | ||
Check out our [Credit for contributions](contribue/../contribute/credit-for-contributions) page to see how to make sure you get acknowledged on the website. | ||
|
||
--- | ||
[issues]: https://github.com/very-good-science/data-hazards/issues | ||
[dec-email]: mailto:[email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Change log | ||
|
||
The change log records when changes that have been made to the project and gives a brief description of what the changes were. | ||
The change log started in March 2022. | ||
The most recent changes should be at the top of the list. | ||
|
||
<!-- Example change log entry | ||
|
||
## DD-MM-YYYY: <10 words to summarise change | ||
More detailed paragraph (~100 words is more than enough!) that describes the changes in more detail and their impact. | ||
[Your name](link to your github profile) --> | ||
|
||
## 07.03.2022: Move Data Hazards to individual pages | ||
[@ninadicara](https://github.com/ninadicara) | ||
Moved all of the Hazards to their own individual pages, and linked them from the original sphinx panels. | ||
Also capitalised all of the names so that they are consistently named. | ||
This should make it easier for people to contribute to a single Hazard and record their contribution against it :) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Credit for contributions | ||
|
||
We strongly believe everyone should be credited for their contribution to this project, no matter how big or small! | ||
We also want people to be able to use their contributions to open source projects like this one as evidence in their CVs or applications. | ||
|
||
To achieve this aim we have two ways to be acknowledged on the site: - you can do both or just (1): | ||
|
||
1. Be added to the front page list of contributors, which uses the [all-contributors bot](https://allcontributors.org/). | ||
2. Add a more detailed overview of your contribution to the [Record of contributions](contributors). | ||
|
||
## 1. Add yourself to our contributors list with all-contributors | ||
|
||
We have an [open issue](https://github.com/very-good-science/data-hazards/issues/109) for adding people to the list of contributors. | ||
The all-contributors bot [uses an emoji key](https://allcontributors.org/docs/en/emoji-key) that recognises lots of different types of contribution. | ||
If you do anything on the website (from fixing a broken link or typo all the way to writing a new page) then please do add yourself using the instructions on the issue! | ||
We will do our best to add you too, but it is often faster for you to do it :) | ||
|
||
To use it, comment in an issue or pull-request something like: | ||
`@all-contributors please add @NatalieThurlby for eventOrganizing` | ||
The bot will then set up a pull-request (PR) to add the named person to the contributors list, and the PR will update the list of contributors at the bottom. We have an open issue that we use to call the all-contributors bot. | ||
|
||
Some people aren’t on GitHub of course, so to add them to the contributions list you can manually edit the file .all-contributorsrc by adding the following object to the list: | ||
``` | ||
{ | ||
"login": "", | ||
"name": "FirstName SecondName", | ||
"avatar_url": "https://www.example.com/profile-pic.jpg", | ||
"profile": "https://mywebsite.com", | ||
"contributions": [ | ||
"content" | ||
] | ||
}, | ||
``` | ||
This person’s contribution will then show up the next time you use the bot to add someone to the repo. | ||
|
||
|
||
## 2. Add yourself to our [Record of contributions](contributors) | ||
|
||
It can be useful to have a more detailed description of your involvement in the project. | ||
We would love for everyone to be listed here, but understand it can take a bit of time that not everyone has. | ||
If you would like to be added to the [Record of contributions](contributors) then either [make an issue using the template](https://github.com/very-good-science/data-hazards/issues/new?assignees=&labels=documentation&template=contributors.md&title=Add+new+contributor) or make a PR on the page itself. | ||
Please include the following information: | ||
|
||
* Your Name | ||
* Your Role and Affiliation | ||
* (Optional) ORCID ID or other persistent identifier | ||
* (Optional) Personal contact details or website | ||
* Overview of your contribution to the Data Hazards Project - please don't be modest! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# How to contribute | ||
|
||
Depending on what you would like to do there are different ways to get involved. | ||
Please check out the options below! | ||
If you can't find what you are looking for then [send us an email][dec-email] and we will help! | ||
You can also come to our [open community co-working calls](../events/coworking) if you would like to chat to us about an idea you have had. | ||
|
||
|
||
## Suggesting new or improved Data Hazards | ||
|
||
In the first instance please [start a Discussion with your idea](https://github.com/very-good-science/data-hazards/discussions/new?category=ideas) in the 'Ideas' category. | ||
We can then chat openly on GitHub about the suggestion, and this gives other people the opportunity to weigh-in on any changes we are considering. | ||
Once changes have been agreed then you can follow the process below for [making changes to the website](#making-changes-to-the-website-content). | ||
|
||
If you would rather you can also [email us][dec-email] to discuss. | ||
|
||
## Making changes to the website content | ||
|
||
This website is based on a tool called [Sphinx](https://www.sphinx-doc.org/en/master/), which allows us to create all our content in Markdown and render it as a website. | ||
To find the documentation you want to change or add then follow the file path that is indicated by the website link from the `site` folder in the repo. | ||
To add the changes to the main repository then: | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your own GitHub account. | ||
2. Check that you are happy with the changes by [building the site locally](#build-the-site-locally). | ||
3. Before submitting your changes, please add a note to the [Change Log](changelog) that describes the change you made. | ||
4. Then, once you've made your changes, submit a [pull request](https://help.github.com/articles/creating-a-pull-request): we'll review it as quick as we can 😄. | ||
|
||
If you are fixing an [issue][issues] then please comment on it before you start working so that we don't repeat your work! | ||
|
||
### Build the site locally | ||
|
||
In order to build the site locally, you'll need to run the following from your root directory: | ||
`sphinx-build site/ site/_build/` | ||
|
||
These require some Python packages to run. | ||
You may want to set up a [virtual environment](https://docs.python.org/3/library/venv.html) first, so that you don't install these packages system-wide. | ||
Then you can install the packages using `pip install -r requirements.txt` | ||
|
||
## Adding slides | ||
We try to keep all our slides for Data Hazards on our website. | ||
|
||
The current process is: | ||
1. (Optional) create slides in powerpoint, upload to Google drive (which will convert it to Google slides) + check formatting (alternatively, create in Google slides) | ||
2. Create a new markdown web page. | ||
2. Publish google slides `File -> Publish to the web -> Embed -> Small` | ||
3. Copy and paste to new markdown web page. | ||
3. Make viewable with link `Share -> Anyone on the internet with this link can view` | ||
4. Add link to markdown web page. | ||
|
||
Recommendations for a process to create html slides that works with myst markdown extremely welcome! | ||
|
||
--- | ||
[issues]: https://github.com/very-good-science/data-hazards/issues | ||
[dec-email]: mailto:[email protected] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this bit