Skip to content

Commit

Permalink
Merge pull request #1056 from alan-turing-institute/malvikasharan-gso…
Browse files Browse the repository at this point in the history
…d20-draft

Draft of GSOD 2020 application
  • Loading branch information
malvikasharan committed Apr 27, 2020
2 parents d6fac9f + 4c8df32 commit c3dfc05
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions communications/GSOD-applications/2020-gsod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Google Season of Docs (GSOD) 2020

* Website: https://developers.google.com/season-of-docs
* Location: Distributed/online
* Date: 10-11 March 2020
* Context: Technical writers spend three months working closely with an open source community and learn about open source and new technologies.
* INCF call for the organisation partners: https://www.incf.org/blog/call-mentors-join-us-gsod-2020
* Previous year’s application: https://github.com/alan-turing-institute/the-turing-way/issues/406

### Title

* The Turing Way, a how to guide to data science

**Description:**

The Turing Way is an open-source, community-led and collaboratively developed book project on making data research accessible for a wider research community ([https://the-turing-way.netlify.com](https://the-turing-way.netlify.com)).
We bring together individuals from diverse fields and expertise to develop practices and learning resources that can make data research comprehensible and easy to understand.
The project is openly developed and all questions, comments, recommendations and discussion are facilitated through an [online GitHub repository](https://github.com/alan-turing-institute/the-turing-way).

Our community members are researchers, engineers, data librarians, industry professionals, and experts in various domains, at all levels of seniority, from all around the world.
Since the project's launch in April 2019, they have co-authored chapters on [research reproducibility](https://the-turing-way.netlify.app/reproducibility/reproducibility.html) by compiling best practices, tools and recommendations used by the scientific communities worldwide.

Since the project has grown from a small team of 10 researchers to a community of 125 contributors, the scope of The Turing Way book has also expanded to include different aspects such as project design, collaboration, communication, and ethics in data research ([preview](https://deploy-preview-977--the-turing-way.netlify.app/welcome), pull request [#977](https://github.com/alan-turing-institute/the-turing-way/pull/977)).
The project aims to provide learning and training resources on a wide array of topics and builds on case studies provided by Turing researchers, impact stories contributed by individuals, and workshops delivered by the team members.

For this project, the GSOD technical writer will review the [existing chapters](https://github.com/alan-turing-institute/the-turing-way/tree/master/book/content) and provide editorial support on incorporating new content, such as the chapters on [distributed collaboration](https://github.com/alan-turing-institute/the-turing-way/issues?q=is%3Aissue+is%3Aopen+label%3Acollaboration-book), which are currently under development.
Based on their personal preference, they will have the possibility to contribute to one or more newly proposed sections of the book by developing resources (in English) such as new chapters, interactive tutorials, impact stories, and case studies with the help of our community members.
If they have a good understanding of Chinese, Hindi or Spanish, they can also choose to translate the existing materials in one of these languages.
They will be provided with appropriate guidance and opportunity to work in a positive working environment.
They will be fairly acknowledged for their contributions to the project.
The final goal will be to identify opportunities to enhance the quality of the book by improving its language and structure that can make The Turing Way accessible for graduate students, research software engineers, senior investigators and administrative teams.

*Optional technical reading:*
The Turing Way is hosted as a [Jupyter Book](https://github.com/jupyter/jupyter-book/) at https://the-turing-way.netlify.com. Jupyter Books can format markdown files and Jupyter notebooks as static HTML making them easy to read.
When a notebook is included in the book, the static page includes a link to an interactive version of the notebook via [Binder](https://mybinder.readthedocs.io).
We are upgrading to the latest version of Jupyter book and intend to integrate more interactive features, which are currently underutilised.
The translation efforts are supported through [Transifex](https://www.transifex.com/theturingway/theturingway/dashboard/).

**Required skills:**

- Writing and editing skills in the English language
- Experience working in distributed communities, ideally using git and GitHub

**Optional skills:**

- Experience collaborating on data science or quantitiative research projects at any level
- Interactive visualisation
- Data science ethics
- Community building
- Translating English content into Chinese, Hindi or Spanish

**Possible mentors:**
- Kirstie Whitaker (kwhitaker@turing.ac.uk)
- Malvika Sharan (msharan@turing.ac.uk)

**Expected outcome:**

An enhanced version of The Turing Way’s existing chapters, editorial support for new contributions by the community members and resource development for one of the newly proposed sections of the book.

**Difficulty level:**
Medium if the candidate has prior experience of working with git and GitHub.
However, resources and guidance will be provided by the mentors.

0 comments on commit c3dfc05

Please sign in to comment.