Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
hanneoberman authored Nov 13, 2023
2 parents c8f5ad6 + bca0c3d commit 5e08a38
Show file tree
Hide file tree
Showing 14 changed files with 817 additions and 5 deletions.
9 changes: 9 additions & 0 deletions book/website/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ parts:
sections:
- title: Research Data
file: reproducible-research/rdm/rdm-data
- title: Finding Data
file: reproducible-research/rdm/rdm-find
- title: Data Management Plan
file: reproducible-research/rdm/rdm-dmp
- title: The FAIR Principles and Practices
Expand Down Expand Up @@ -746,6 +748,13 @@ parts:
file: community-handbook/infrastructure/infrastructure-contributors
- title: External Link Checking
file: community-handbook/infrastructure/infrastructure-external-link-check
- title: Communication Platforms
file: community-handbook/communication-channels
sections:
- title: Slack Start Guide
file: community-handbook/communication-channels/slack-start-guide
- title: Slack Welcome Guide
file: community-handbook/communication-channels/slack-welcome-guide
- title: Monthly Newsletters
file: community-handbook/newsletters
sections:
Expand Down
13 changes: 13 additions & 0 deletions book/website/communication/peer-review/peer-review-open.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
(cm-pr-open)=
# Open Peer Review

```{figure} ../../figures/open-peer-review.*
---
height: 500px
name: open-peer-review
alt: Cartoon-like sketch, in black and white with orange shading, of a three tiered cake with the title Open Peer Review at the top. On the bottom level of the cake is the word collaboration with different types of people standing on this level of the cake looking thoughtful. Each person has a speech bubble over them with an eye in it. There are more thoughtful people standing on the second tier and the third and top tier has three people holding a written document with the words supporting quality over them. At the side of the cake are the words recognition, on the left side, and content and process, on the right side.
---
_The Turing Way_ project illustration by Scriberia. Used under a CC-BY 4.0 licence. DOI: [10.5281/zenodo.3332807](https://doi.org/10.5281/zenodo.3332807).
```

## What is Open Peer Review?

Open Peer review can refer to various practises, including signing your review, publishing reviews along with the paper, and allowing for the community to contribute to the peer review process ([Open Science Community Utrecht](https://openscience-utrecht.com/peer-review)). Below some different types of Open Peer Review are highlighted, as well as the benefits of opening up the peer review process.
Expand Down Expand Up @@ -56,3 +65,7 @@ The ability of double-anonymized review to address biases in peer review remains
* [F1000](https://f1000research.com/)
* [Open Research Europe](https://open-research-europe.ec.europa.eu)
* [SciPost](https://scipost.org/)
* [Peer Community In](https://peercommunityin.org/)



9 changes: 9 additions & 0 deletions book/website/community-handbook/communication-channels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
(ch-communication-platforms)=

# Communication Platforms

_The Turing Way_ delivery team uses a number of communication platforms to share the work of the community work outwards, and to communicate in real-time as well (alongside Github, which hosts the project repository and all sorts of updates).

Examples of this may include social media platforms, as well as real-time messaging services.

This section aims to collect the policies and practices that we employ across our communication platforms in one place, which are you free to use for your own community platforms.
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Quick Start Guide for Slack

Welcome to the community Slack group: a place for you to network, collaborate, exchanges resources and share ideas with others in the community.

**Table of content**

1. [Configuring your account](#1-Configuring-your-account)
2. [Notification settings](#2-Channel-and-Notification-settings)
3. [Communicating with others](#3-Communicating-with-others)

## 1. Configuring your account

### PROFILE

* **Your username** – please use a name by which others will be able to identify you. Your email address is visible to others.
* **Your avatar** – please add a profile picture or other identifier that you’re comfortable with so that others can associate your posts with you more easily.
* **Your time zone** – this determines when Slack will notify you and can also help others know whether it’s a reasonable time of day to get in touch.

Here is a guide to help you [edit your profile]( https://slack.com/intl/en-ca/help/articles/204092246-Edit-your-profile).

### STATUS UPDATES

Status updates can be a useful way to let others know your availability as your status will be visible to everyone in the Slack group.

To update your status, click your name in the top left of the screen and select `update status`. You can select when you want your status update to be removed by stipulating a timeframe from the “clear after” dropdown.
You can clear a status update at any time by clicking on your name and selecting `clear status` from the dropdown.

## 2. Channel and Notification settings

### How to find, join and create channels

By default, you’re automatically added to the main channels that everyone belongs to (for example, #general, #welcome, #introductions & #random).

You will be able to create additional channels to facilitate structured conversation. You are free to create as many channels as you would like. However, channels dedicated to projects should be made public (not private) so people can collaborate or help you.

### Configure your notifications
Slack notifications are great, but they may bother you when you try to focus on your project. There are a lot of options for you to determine how and when you are informed about content – and at what level of granularity.

#### For the overall group
1. Click on your `name` at the top left of the page and select “`preferences`” from the dropdown
1. In the Notifications section you have options which include:
* Set times when you do not want to be disturbed by notifications
* Enable desktop notifications
* Choose to be alerted when certain keywords are mentioned

#### Channel by channel
1. When you’re in a channel, click the “`i`” icon at the top right. Choose “`more`” and then click “`notifications`.”
* Here you have the option to ignore any @channel messages, or mute the channel entirely.

#### Following a specific thread
If another group member posts something of particular interest you can choose to follow that thread. Find how to reply in thread in [Section 3](#3-Communicating-with-others).

1. Click the `ellipsis (three dots)` to the right of the original post and select “`follow message`” from the dropdown.

#### Getting a reminder about a specific thread
You additionally have the option to be reminded about a
thread at a more convenient time. From the `ellipsis` to the right of the original post select “`remind me about this`” from the dropdown and choose a timeframe.

### Muting or leaving channels
If a channel has become too noisy, you can additionally:
* **Mute** it: When you’re in a channel, click the “`i`” icon at the top right. Choose “`more`” and then choose “`mute`” from the dropdown.
* **Leave** it: When you’re in a channel, click the “`i`” icon at the top right. Choose “`more`” and then choose “`leave`” from the dropdown.

## 3. Communicating with others

### A FEW POINTS OF ETIQUETTE

#### Use threads to continue conversations

* When someone posts a brand new item in a channel, anyone in the channel can reply directly to it, creating a thread. Threads allow separate conversations to take place in the group without confusion – and for members to choose which of those conversations to follow more closely.
* To add a comment to a thread, click the :left_speech_bubble: to the right of an existing post.

#### Use @channel, @here and other handles sparingly

* If you type **@channel** or **@here** or other general handles (**@participants** or **@instructors**, & **@admin**) in a post or comment that will send a notification to everyone in that channel. Please use this only for items that really do need everyone’s attention.

#### Respect the context of this shared space

* We want it to be somewhere where learning can happen in a supportive, safe environment.
* Please **DO NOT** take conversations out of context and copy/paste them elsewhere without the permission of all the individuals who posted.

#### Not all communications will be synchronous

* While IM-based conversations can feel very immediate, please don’t feel that you have to respond to messages immediately, nor expect others to respond immediately. We’re all busy, really busy!


#### Message Editing & Deletion

* You are allowed to edit your messages at any time. That means if you edit a message after someone replied to it, make it clear that you edited something if it changes the meaning of your message. See the example in the GIF below.

### SENDING PRIVATE/DIRECT MESSAGES
It can be helpful to others when you’re sharing resources and brainstorming solutions to “work out loud” in a specific thread because then your learning becomes a future resource for others, too.

However, sometimes you want to start a private conversation. To do this, go to the `direct messages` (DM) section on the bottom left of the left-hand side bar. Click the `+` icon to start a new message. You can add more than one recipient to create a group message.

#### Direct message when necessary
You may feel tempted to use DM instead of asking questions in dedicated channels. If an instructor believes others will benefit from the answer, they will probably encourage you to ask your question in the appropriate channel. If you have a question, others likely have the same one, we are all learning from each other.

That said, DM are useful to discuss privately with other people (one or many) and you don't want to flood a channel.


### Sending files

Yes, you can send files (< 1 GB) in public channels and in direct messages. See this [how to guide](https://slack.com/intl/en-ca/help/articles/201330736-Add-files-to-Slack) for help.

# References

The Slack section was adapted from a resource by BrainHackMTL and the Center for Scientific Collaboration and Community Engagement ([CSCCE](https://www.cscce.org/)) under a [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/): [10.5281/zenodo.3763730](http://dx.doi.org/10.5281/zenodo.3763730).

Licensed under a [CC BY 4.0 license.](https://creativecommons.org/licenses/by/4.0/)
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
![Alt: Two people, one woman with a long orange shirt and one guy with a blue shirt and a tie, and a large Welcome! sign at the back](https://i.imgur.com/NXOPPc4.jpg)

# Welcome to *The Turing Way* Slack!

Slack is one of our core communication channels within the *The Turing Way* community. It is a space where folks ask questions, learn about each other's work, and get involved with *The Turing Way* and other projects. While it is not the *only* communication channel used by the community, it is a popular platform, increasingly used by remote teams around the world.

*Here is a short guide to the default slack channels (meaning, you've already been added to them when you joined this space!)*:
* [#announcements](https://theturingway.slack.com/archives/C014ZE7SKK3): Ping you about recurring community calls and community events (feel free to mute!)
* [#ask-away](https://theturingway.slack.com/archives/C01ESKR7WN4): Use this channel to ask any question you might have - general or specific, and we'll make sure to redirect you to the right resources
* [#community](https://theturingway.slack.com/archives/C014KE9A9LM): Topics related to the community, celebrations, collaborations, and other projects
* [#general](https://theturingway.slack.com/archives/C014LRAK48J): For general-purpose conversations & questions
* [#github-related-posts](https://theturingway.slack.com/archives/C014LRL27KL): For chapter ideas and discussions, as well as ongoing projects within the github repository.
* [#ideas-for-discussion](https://theturingway.slack.com/archives/C014ZE7SL9F): For discussion and ideas, related to the guides & otherwise
* [#introductions](https://theturingway.slack.com/archives/C014LUYEF5G): Feel free to introduce yourself here!
* [#random](https://theturingway.slack.com/archives/C01BUPURLAW): For all other questions, comments not related to *The Turing Way*
* [#welcome](https://theturingway.slack.com/archives/C014ZE49HH7): A bot is installed in this channel, that tags you with a random greeting & flag to represent our global community :sparkles:

*There are also a number of channels dedicated to specific types of work and questions within the community (all are welcome!)*:

* [#accessibility](https://theturingway.slack.com/archives/C01E654A42E): Join for discussions around accessibility practices within the community, and the upcoming work of a new working group
* [#environmental-sustainability](https://theturingway.slack.com/archives/C04RCMAEPUZ): Join for discussions about environmental sustainability, co-hosted with the Environmental Data Science Book.
* [#translation](https://theturingway.slack.com/archives/C01E17C1K35): Join to learn about all things translation & localisation, as well as ongoing meetings and projects within the team
* [#infrastructure](https://theturingway.slack.com/archives/C01EUGMQSNP): Learn more about project architecture, and get involved with technical infrastructure aspects of the project
* [#reviewers-editors-wg](https://theturingway.slack.com/archives/C043N2KSVND): Learn more about how to review & edit ongoing writing projects within *The Turing Way*
* [#trainers-mentors-wg](https://theturingway.slack.com/archives/C0425F98E5U): Help to review ongoing promotion materials, and learn how how you can mentor other community members
* [#user-experience](https://theturingway.slack.com/archives/C052J9UCGMP): Join the ongoing efforts around user experience and design within the community.

*You might also be interested in joining the following channels*:
* [#en-español](https://theturingway.slack.com/archives/C01DY1F5R53): Para hispanohablantes en la comunidad
* [#events](https://theturingway.slack.com/archives/C017WM4QD24): for upcoming events in the open science network
* [#jobs-and-opportunities](https://theturingway.slack.com/archives/C02SNNW40BZ): for jobs, workshops, and other related opportunities
* [#reading-recommendations](https://theturingway.slack.com/archives/C0256MW3HDW): For reading recommendations from community members
* [#research-data-management](https://theturingway.slack.com/archives/C01FATFLDPA): For folks with an interest in research data management skills, practices, and tools.

*We also have Slack channels dedicated to each guide*:
* [#guide-for-collaboration](https://theturingway.slack.com/archives/C01LUTU8FPD)
* [#guide-for-communication](https://theturingway.slack.com/archives/C01M7APDG9X)
* [#guide-for-ethics](https://theturingway.slack.com/archives/C01CP215WF4)
* [#guide-for-project-design](https://theturingway.slack.com/archives/C01M7B1T95F)
* [#guide-for-reproducibility](https://theturingway.slack.com/archives/C023KPNR2N4)

If there are any other channels you'd like to see in the workspace, or ones that we use that you don't see listed here – please feel free to correct this page by making an issue or pull request on Github.

## Best Practices for using Slack

As with all of our communication channels, *The Turing Way* slack abides by our [Code of Conduct](https://the-turing-way.netlify.app/community-handbook/coc.html).

We are in the process of developing platform-specific guidelines for Slack and other community platforms. While these are being developed, here are a few general guidelines to get you started:

* **Images**: Use alt text to describe images, diagrams, or other visuals ([Learn more about how to do this in this tutorial.](https://slack.com/intl/en-gb/resources/using-slack/how-to-boost-accessibility-in-slack&utm_medium=promo)). Don't forget to add important information like context in your description!
* **Links**: If you are inserting a link into a message, limit the number of embedded links within a message. Avoid embedding links within replies to messages when possible, as links posted within threads are not readable for screen readers.
* **Emojis**: Limit the use of emojis that break up narrative flows of information where possible (such as emojis listed between works). Remember that not all people are able to access the emoji reactions option within Slack, and use written affirmations as well!
* **Bandwidth**: In order to make sure that Slack is accessible in low-bandwidth environments for the community, avoid posting data-intensive content like videos directly into the channels. Instead, prioritise hosting the content on other platforms (such as YouTube), and sharing the link.
* **Openness**: Remember that not everyone in the *The Turing Way* community is in the Slack workspace – or on every social media channel. Where possible – especially when discussing chapter ideas and other collaborations – create issues and discussions on the Github repository or post across social media channels, in order to ensure the widest reach and participation possible.

In general, we encourage an approach to Slack that is as accessible as possible, for as many people as possible. Please practice kindness when you communicate with others, and be mindful of cultural, linguistic, disability, and individual differences that may affect how people communicate online.

Is there anything we are missing? Please reach out to the Research Community Manager Anne Lee Steele on Slack or by email at [email protected], or to any members of the core team listed on this [Ways of Working document](https://github.com/alan-turing-institute/the-turing-way/blob/main/ways_of_working.md).

## Getting started with The Turing Way

* :books: If you want to dive right in to editing the book, check out a Pull Request or Issue on the [Github repository](https://github.com/alan-turing-institute/the-turing-way). Use the tags to navigate through the issues and pull requests. Ones tagged `good first issue` or `good first PR` are a great place to start.

## Don't know where to start?

* Feel free to send me (Anne Lee Steele) a message on Slack or email at [email protected] if you have any questions or don’t know where to start. I’m the Community Manager (but just one of many leaders in this community), and here to help!
* You can drop into [Office Hours](https://hackmd.io/@turingway/office-hours) with me every Friday, or schedule a chat on [Calendly](https://calendly.com/aleesteele/).
* Join us at a [Collaboration Cafe](https://hackmd.io/@turingway/collaboration-cafe), which happen on a bi-monthly basis on Wednesdays to meet more members of the community, and learn more about the project.
Loading

0 comments on commit 5e08a38

Please sign in to comment.