Skip to content

Commit

Permalink
Merge pull request the-turing-way#3263 from the-turing-way/updatePaths
Browse files Browse the repository at this point in the history
switch alan-turing-institute/the-turing-way to the-turing-way/the-turing-way
  • Loading branch information
bsipocz authored Aug 10, 2023
2 parents e28bbd4 + 4134f6a commit add0a22
Show file tree
Hide file tree
Showing 67 changed files with 403 additions and 403 deletions.
2 changes: 1 addition & 1 deletion book/.words.lst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ```
# WARNING: several misspellings are included in this file that may been used in HTML tags or links.
#
# We are not maintaining this file actively. See PR #1652 (https://github.com/alan-turing-institute/the-turing-way/pull/1652/) for detail.
# We are not maintaining this file actively. See PR #1652 (https://github.com/the-turing-way/the-turing-way/pull/1652/) for detail.
#
# This comment may need to be removed from this file before calling aspell.
#
Expand Down
4 changes: 2 additions & 2 deletions book/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## The Turing Way Book

This is the README file for _The Turing Way_ book hosted online at https://the-turing-way.netlify.app/.
For the README file of the main repository please [follow this link](https://github.com/alan-turing-institute/the-turing-way/blob/main/README.md).
For the README file of the main repository please [follow this link](https://github.com/the-turing-way/the-turing-way/blob/main/README.md).

All the text for each chapter of the `book` lives inside the folder `./website` directory.
All figures associated to the chapters are stored in and linked from the `./website/figures` directory.
Expand Down Expand Up @@ -89,7 +89,7 @@ You can find the build history or logs for _The Turing Way_ at https://app.netli
## Bibliography

In the directory `./website/_bibliography` a collection of bibliography from all the chapters exist in the `references.bib` file.
More details can be read in the [CONTRIBUTING.md](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md#referencing-and-citing) file.
More details can be read in the [CONTRIBUTING.md](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md#referencing-and-citing) file.

## Content Templates

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In the label, replace `keyidea1` with a word that best describes the section or
> The [style guide](https://the-turing-way.netlify.app/community-handbook/style/style-citing.html) also contains _The Turing Way's_ recommendations for referencing and citation.
> To include an image in your writing, use the MyST directive shown below.
> Remember to add your image to the `figures` [folder](https://github.com/alan-turing-institute/the-turing-way/tree/main/book/website/figures) and use the correct path, else it will not be displayed.
> Remember to add your image to the `figures` [folder](https://github.com/the-turing-way/the-turing-way/tree/main/book/website/figures) and use the correct path, else it will not be displayed.
```{figure} ../../figures/image-name.png
---
Expand Down
6 changes: 3 additions & 3 deletions book/website/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ html:
use_issues_button : true # Whether to add an "Open issue" button to pages. If `true`, repository information in repository: must be filled in
use_edit_page_button : true # Whether to add an "Suggest edit" button to pages. If `true`, repository information in repository: must be filled in
baseurl : "https://the-turing-way.netlify.com" # The base URL where your book will be hosted. Used for creating image previews and social links. for example: https://mypage.com/mybook/
extra_navbar : Visit our <a href="https://github.com/alan-turing-institute/the-turing-way">GitHub Repository</a>
extra_navbar : Visit our <a href="https://github.com/the-turing-way/the-turing-way">GitHub Repository</a>
<div>This book is powered by <a href="https://jupyterbook.org">Jupyter Book</a></div>
extra_footer: |
The Turing Way Community makes all of their materials publicly available under <a href="https://github.com/alan-turing-institute/the-turing-way/blob/main/LICENSE.md">open source licenses</a>
The Turing Way Community makes all of their materials publicly available under <a href="https://github.com/the-turing-way/the-turing-way/blob/main/LICENSE.md">open source licenses</a>
comments:
hypothesis : true

Expand All @@ -46,7 +46,7 @@ launch_buttons:
thebelab : false # Add a thebelab button to pages (requires the repository to run on Binder)

repository:
url : https://github.com/alan-turing-institute/the-turing-way # The URL to your book's repository
url : https://github.com/the-turing-way/the-turing-way # The URL to your book's repository
path_to_book : "book/website" # A path to your book's folder, relative to the repository root.
branch : main

Expand Down
488 changes: 244 additions & 244 deletions book/website/afterword/contributors-record.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion book/website/collaboration/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ In this guide, we welcome contributions in developing guidance on the following
* Defining explicit expectations
* Participatory co-creation

Check out our [contributing guidelines](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) to get involved.
Check out our [contributing guidelines](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md) to get involved.
2 changes: 1 addition & 1 deletion book/website/collaboration/coworking.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,6 @@ This is likely a combination of a co-mentoring call and a co-working Pomodoro ca

You can read an adapted version of their blog post along with other ideas for virtual events in the document by Center for Scientific Collaboration and Community Engagement {cite:ps}`CSCCE2020virtual`.

If you organise or host a coworking call in your community, you are welcome to highlight them in this chapter by creating a [pull request](https://github.com/alan-turing-institute/the-turing-way/pulls) on the GitHub repository (see [contributing guidelines](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) for details).
If you organise or host a coworking call in your community, you are welcome to highlight them in this chapter by creating a [pull request](https://github.com/the-turing-way/the-turing-way/pulls) on the GitHub repository (see [contributing guidelines](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md) for details).

***Chapter Tags**: This chapter is curated for the `Turing Data Study Group` (`turing-dsg`).*
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In Github, there are five levels of permissions: read, triage, write, maintain,
* Maintain permission is for project managers but have no access to sensitive or destructive actions (such as project deletion).
* Admins are people who have full access to the project, including sensitive and destructive actions, and are responsible for granting permission to make other contributors.

These roles are often defined in a project file such as a [CODEOWNERS file](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) or a Ways of Working file (see _The Turing Way_'s [Ways of Working](https://github.com/alan-turing-institute/the-turing-way/blob/main/ways_of_working.md) as an example).
These roles are often defined in a project file such as a [CODEOWNERS file](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) or a Ways of Working file (see _The Turing Way_'s [Ways of Working](https://github.com/the-turing-way/the-turing-way/blob/main/ways_of_working.md) as an example).
These files provide insight into the core project team and members responsible for maintenance roles in the project.

In this chapter, anyone with triage, write and maintain permission is referred to as maintainers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ These details should throw light on what the project is all about, why was it cr

These three documents are a good start towards building these documents:
- A project should contain a {ref}`README.md file<pd-project-repo-readme>` that provides the important details and links to resources that one must know to become a member of the project.
- A Code of Conduct (see _The Turing Way_ [Code of Conduct](https://github.com/alan-turing-institute/the-turing-way/blob/main/CODE_OF_CONDUCT.md)) must be provided in every project to establish that a welcoming and safe environment for community members while collaborating.
- A well-written contribution guideline (see _The Turing Way_ [Contributing file](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md)) is extremely important when the collaboration is done remotely on any project to ensure clear communication between contributors and maintainers.
- A Code of Conduct (see _The Turing Way_ [Code of Conduct](https://github.com/the-turing-way/the-turing-way/blob/main/CODE_OF_CONDUCT.md)) must be provided in every project to establish that a welcoming and safe environment for community members while collaborating.
- A well-written contribution guideline (see _The Turing Way_ [Contributing file](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md)) is extremely important when the collaboration is done remotely on any project to ensure clear communication between contributors and maintainers.

2. *Effective communication*: The conversations regarding any contribution can be made public for others to join for a discussion while working on small features and ideas.
This will involve more people and ensure transparency in open source work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ While reading this chapter, please be aware that you may need to make adjustment
- Value different types of contributions - coding projects are not only about code, therefore list documentation and other management skills as well.
- You can use the {ref}`Persona Creation Tool<pd-persona-creation>` or the [Personas and Pathways exercise](https://mozillascience.github.io/working-open-workshop/personas_pathways/) to brainstorm who could be your possible community members.
- Here is a [template of community guideline](https://gist.github.com/PurpleBooth/b24679402957c63ec426) provided by the GitHub user [PurpleBooth](https://gist.github.com/PurpleBooth).
- See [_The Turing Way_'s contributing file](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) for reference.
- See [_The Turing Way_'s contributing file](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md) for reference.

(cl-new-community-leadership)=
### 5. Create a Basic Management/Leadership Structure:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Recognising contributors by recording their names in visible locations (like a c
Announce and celebrate all kinds of work by communicating them openly in official community forums and channels.
You can use GitHub actions, bots or a continuous integration pipeline to automate the process.
To take another easier approach, you can install the all-contributors bot by [https://allcontributors.org](https://allcontributors.org) to your repository, which can help you recognise contributions including those that don’t involve pushing code.
See it working on [_The Turing Way_ repository](https://github.com/alan-turing-institute/the-turing-way#contributors).
See it working on [_The Turing Way_ repository](https://github.com/the-turing-way/the-turing-way#contributors).

## Sharing Project Ownership with the Community

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Outputs should be written straightforwardly to make them more accessible to thos
* However, not all communications should be in English.
Researchers need to consider the wider audience of their communications.
There may be a specific community with another language that needs to be engaged fully in the research and therefore communications should be translated.
* Global research communities should also consider translating key documents into additional languages as has been done for our project [README file](https://github.com/alan-turing-institute/the-turing-way/blob/main/README.md).
* Global research communities should also consider translating key documents into additional languages as has been done for our project [README file](https://github.com/the-turing-way/the-turing-way/blob/main/README.md).

## FAIR resources

Expand Down
2 changes: 1 addition & 1 deletion book/website/communication/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ In this guide, we welcome contributions to developing chapters and guidance on e
We are excited to support data scientists _like you_ to develop skills ranging from how to make your work openly available, interactive visualisation, how to give a talk, writing your first paper, and being interviewed by the media.

_The Turing Way_ itself is a [Jupyter Book](https://jupyterbook.org/intro.html), which is an open source tool for building beautiful, **publication-quality** books, websites and documents from source material that contains computational content. Please also consider how we can make our communications about this more exciting!
Check out our [contributing guidelines](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) to get involved.
Check out our [contributing guidelines](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md) to get involved.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Different Contributions and their Acknowledgements

In the previous subchapters, we discussed how we acknowledge our contributors for their work in _The Turing Way_.
We also describe the [Contributors section](https://github.com/alan-turing-institute/the-turing-way#contributors) of the [`README`](https://github.com/alan-turing-institute/the-turing-way/blob/main/README.md) file and the [`contributors.md`](https://github.com/alan-turing-institute/the-turing-way/blob/main/contributors.md) file as {ref}`Record of Contributions<ch-acknowledgement-record>`, which are updated regularly to reflect the contribution types and personal highlights of the contributors.
We also describe the [Contributors section](https://github.com/the-turing-way/the-turing-way#contributors) of the [`README`](https://github.com/the-turing-way/the-turing-way/blob/main/README.md) file and the [`contributors.md`](https://github.com/the-turing-way/the-turing-way/blob/main/contributors.md) file as {ref}`Record of Contributions<ch-acknowledgement-record>`, which are updated regularly to reflect the contribution types and personal highlights of the contributors.

In this subchapter, we will explore the different types of contributions that exist within _The Turing Way_, and describe those with the help of {ref}`personas and pathways<pd-persona-creation>` our contributors may take to make their contributions.
Furthermore, we describe how each persona will be acknowledged in _The Turing Way_.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ As discussed in the next subchapter, these contributors are highlighted in the {

Many contributors will also make substantial contributions such as writing a subchapter, maintaining community interactions, setting up or maintaining project's infrastructure, helping others in their work and supporting their participation.
All the substantial contributors are also highlighted in the Contributors Table and named as co-authors [{term}`def<Authors>`] on the book as a whole.
As stated in our [Governance document](https://github.com/alan-turing-institute/the-turing-way/blob/main/GOVERNANCE.md), "substantial contribution" is a subjective term.
As stated in our [Governance document](https://github.com/the-turing-way/the-turing-way/blob/main/GOVERNANCE.md), "substantial contribution" is a subjective term.
Therefore, we have tried to add much detail as possible in the next subchapters through personas, contribution types and acknowledgements of those contributions including when a contributor is named as an author.

Authors are listed in alphabetical order by last name.
Expand Down
Loading

0 comments on commit add0a22

Please sign in to comment.