Skip to content

Commit

Permalink
Merge pull request #229 from ropensci-org/removing-twitter
Browse files Browse the repository at this point in the history
  • Loading branch information
yabellini authored Sep 13, 2024
2 parents f5a6c95 + e7bfb7f commit 5a42bb4
Show file tree
Hide file tree
Showing 9 changed files with 73 additions and 103 deletions.
1 change: 0 additions & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ book:
- authorchecklistany.Rmd
- editorchecklistpeer.Rmd
- editorchecklistany.Rmd
- twittercards.Rmd
- editor-meta.Rmd

execute:
Expand Down
6 changes: 3 additions & 3 deletions authorcontent.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Use short headings to guide the reader.

Did others who are not authors of the post make significant contributions to the package or its inspiration?

Thank reviewers using their first and last names linked to their [rOpenSci author page](https://ropensci.org/authors/) if they have one, or to their relevant online presence (e.g. website, Twitter, GitHub) and link to the software review thread.
Thank reviewers using their first and last names linked to their [rOpenSci author page](https://ropensci.org/authors/) if they have one, or to their relevant online presence (e.g. website, social media, GitHub) and link to the software review thread.
There is no obligation to do this, but you could note something specific that you improved in your package or in your coding or documentation practice as a direct result of reviewers’ comments.

### Consider including a call to action {#action}
Expand All @@ -107,14 +107,14 @@ Consider opening issues to illustrate your thinking.
If you’re willing to consider code or documentation contributions from others, label those issues “[help wanted](https://github.com/search?q=org%3Aropensci+label%3A%22help+wanted%22+state%3Aopen&type=Issues)” (no hyphen, no emojis) and “[good first issue](https://github.com/search?q=org%3Aropensci+label%3A%22good+first+issue%22+state%3Aopen&type=Issues)” or “[beginner](https://github.com/search?q=org%3Aropensci+label%3A%22beginner%22+state%3Aopen&type=Issues)” if those apply. People who want to contribute to rOpenSci can find these by searching GitHub (example: [org:ropensci label:"help wanted" state:open](https://github.com/search?q=org%3Aropensci+label%3A%22help+wanted%22+state%3Aopen&type=Issues)), and we occasionally feature these in our [newsletter](https://news.ropensci.org/).

If you want people to tell you how they have used your package, tell them how you want them to do that. Encourage them to submit their use case to our [public forum](https://discuss.ropensci.org/c/usecases).
There’s a template to help. We tweet these to help others see applications and we tag both the package author and use case submitter to give credit.
There’s a template to help. We share these on social media to help others see applications and we tag both the package author and use case submitter to give credit.
For longer form use cases, they could submit a vignette to include as an article in your package documentation ([example](https://docs.ropensci.org/cyphr/articles/data.html)).

If you want people to give you general feedback, tell them how you’d like to receive that.

### Conclusion or summary {#conclusion}

Will readers understand your take-home message clearly enough to tweet about your post?
Will readers understand your take-home message clearly enough to share on their social media about your post?
You might need to remind them of your main points.

Now **[review the Technical Guidelines](#technical)** for submitting your draft post, and you’re ready to go.
15 changes: 9 additions & 6 deletions authorpromote.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ Blog posts then live a life of their own: some people will still access them, e.

When your post is published, here is what we do to promote it.

- Tweet from [rOpenSci](https://twitter.com/rOpenSci) with a link to your post, tagging post author(s) and package reviewers with a link to the software peer review thread where relevant.
rOpenSci has more than 25,000 followers on Twitter.
- Post from [rOpenSci Mastodon account](https://hachyderm.io/@rOpenSci) and [LinkedIn page](https://www.linkedin.com/company/ropensci/) with a link to your post, tagging post author(s) and package reviewers with a link to the software peer review thread where relevant.
rOpenSci has more than 2,000 followers on Mastodon and more than 1,000 on LinkedIn.

- List your post, with author names, in our [biweekly newsletter](https://ropensci.org/news).
Our newsletter has more than 2,000 email subscribers and additional readers through RSS & JSON feeds.
- List your post, with author names, in our [monthly newsletter](https://ropensci.org/news).

- Our blog and tech notes are syndicated to and tweeted by [R-bloggers](https://www.r-bloggers.com/) and [R Weekly](https://rweekly.org/). R-Bloggers _cross-posts_ posts so it adds page views we can't measure, whereas R Weekly drives traffic to blog posts on our website. R-Bloggers had nearly 80,000 Twitter followers in February 2020.
Our newsletter is opened by more than 1,000 readers each month and additional readers through RSS & JSON feeds.

Consult [Understanding Twitter cards](#twittercards) if you would like to learn about using the YAML metadata in your post to influence the appearance when someone shares a link to your post on Twitter, or Slack for example.
- Our blog and tech notes are syndicated to and shared by [R-bloggers](https://www.r-bloggers.com/) and [R Weekly](https://rweekly.org/). R-Bloggers _cross-posts_ posts so it adds page views we can't measure, whereas R Weekly drives traffic to blog posts on our website. R-Bloggers had nearly 80,000 Twitter followers in February 2020. The R Weekly Highlights podcast also regularly features some of our posts.

- Our blog is also syndicated to [Rogue Scholar](https://rogue-scholar.org/about), an archive for scholarly blog posts that provide full-text search, long-term archiving, DOIs and metadata. Your blog post will be assigned a DOI and archived in the Internet Archive. If you have an integration with your ORCID, your blog post will be added to your ORCID profile when we publish.

[This is Yani's ORCID profile as an example](https://orcid.org/0000-0002-4522-7466); if you scroll down until the "Works" session, all the rOpenSci blog posts are listed there.

You are welcome to cross-post to your own website as long as you also link to the rOpenSci website version. [Example](https://juliasilge.com/blog/qualtrics-relaunch/).
44 changes: 23 additions & 21 deletions authortechnical.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```{block, type='summaryblock', echo=TRUE}
This chapter explains the technical details of submitting a blog post or tech note (referred to collectively as "posts") for publication on the rOpenSci website - from drafting in an (R) Markdown template, to submitting for review using GitHub Pull Request infrastructure.
We include advice on commonly used elements like adding [an image](#addimage), [a citation](#addcitation), or [embedding a tweet](#addtweet) in case you need them.
We include advice on commonly used elements like adding [an image](#addimage), [a citation](#addcitation), or [embedding a social media post](#addsocialpost) in case you need them.
```


Expand Down Expand Up @@ -38,9 +38,9 @@ Create or update your author file.

### Why?

The rOpenSci website has a page listing [all authors](https://ropensci.org/author/) who have contributed to a blog post, tech note, or presented in a Community Call.
The rOpenSci website has a page listing [all authors](https://ropensci.org/author/) who have contributed to a blog post, tech note, presented in a Community Call, host a co-working session, delivered a talk about rOpenSci's activities or contribute to some of our projects like the [Champions Program](https://ropensci.org/champions/).
A click on your by-line in a post takes the reader to your author page that has links to your online home, possibly your social media or GitHub profile(s), and a list of all the content you’ve authored on our site.
For staff and leadership team members, editors for software peer review, or members of our Code of Conduct Committee, their rOpenSci title is also listed on their author page.
For staff and leadership team members, editors for software peer review, members of our Code of Conduct Committee, and participants of our Champions Program, their rOpenSci title is also listed on their author page.


### How?
Expand All @@ -57,7 +57,7 @@ blogguidance::show_template("author-file-template.md",
)
```

At minimum, provide your name and a link or your Twitter, GitHub, or GitLab username.
At minimum, provide your name and a link or your Social Media, GitHub, or GitLab username.
Add your usernames or ID's without the "@" or the "https:...". The link field can be your personal website URL, for example.

### Example
Expand All @@ -83,6 +83,7 @@ The folder name must include accents, initials with periods, and hyphens for spa

Look at [other people's folder names](https://github.com/ropensci/roweb3/tree/HEAD/content/author) for examples.

Your author page will show the picture you have on your GitHub profile.

## Post template {#templates}

Expand All @@ -94,7 +95,7 @@ If not, refer to [the instructions to create your draft manually](#manually).
The blogdown New Post RStudio addin creates the post draft in the correct location and fills the post YAML based on metadata you'll have entered.[^2]

* Install `whoami` and `blogdown` (`install.packages(c("whoami", "blogdown"))`) (blogdown version should be at least 1.6.0).
* Install Hugo (to preview the post): `blogdown::install_hugo("0.89.0")` (version recorded in netlify.toml of the roweb3 repository).
* Install Hugo (to preview the post): `blogdown::install_hugo("0.133.0")` (version recorded in netlify.toml of the roweb3 repository).
* Re-start R.
* In RStudio, open the forked `roweb3` project.
* Create a new post by running Addins > New Post or `blogdown:::new_post_addin()`.
Expand Down Expand Up @@ -154,16 +155,14 @@ Add tags to the YAML of your post to make it more findable. Browse [our page tha
For a post about your peer-reviewed package, use 'Software Peer Review', 'community', 'packages', the package name, and any others you see fit.
#### Twitter cards metadata (optional)
#### Social media metadata (optional)
If you're curious about the `description`, `twitterImg`, `twitterAlt` YAML fields in the post metadata and how they can help draw readers to your post, refer to [our explanation of Twitter cards](#twittercards).
Delete `description`, `socialImg` and `socialAlt` YAML fields if you don't use them.

Delete `description`, `twitterImg` and `twitterAlt` YAML fields if you don't use them.

#### Default Twitter text (optional)
Provide default text for tweets when a reader clicks the "Share on Twitter" button by
replacing the value of `tweet: "A post about blabla by @username!"`.
Consider including your (and your coauthors) Twitter handle(s) (`@username`) in the tweet
#### Default social media text (optional)
Provide default text for social media post (Mastodon and LinkedIn) when a reader clicks the "Share on Mastodon" button by
replacing the value of `social: "A post about blabla by @[email protected]!"`.
Consider including your (and your coauthors) Mastodon handle(s) (`@[email protected]`) in the post
text to ensure you get notified when someone shares your post.


Expand All @@ -174,11 +173,13 @@ Regardless of how images are included, they should all contain **alt** text
and consider the following features.

**Alt text**
Every image should be accompanied by alternative text to make it more accessible to people with disabilities and provide a better user experience for everyone.
Every image should be accompanied by alternative text to make it more accessible and provide a better user experience.
The alternative text should convey the meaning or content that is displayed in the image.
Refer [to this tutorial for details on what should go in alternative text](https://www.w3.org/WAI/tutorials/images/informative/),
and see the following sections for how to include alt text.

If you include a picture with text (like a comment on a post or a phrase on a wall), include the text you want to highlight from that image in the alt-text.


**Image features**

Expand Down Expand Up @@ -310,11 +311,12 @@ To get the citation for an article in [Google Scholar](https://scholar.google.co
knitr::include_graphics("images/citation-gscholar.png")
```

### Embedded tweets {#addtweet}
### Referencing social media posts {#addsocialpost}

Use a [Hugo shortcode](https://gohugo.io/content-management/shortcodes/#tweet) to embed a tweet using its username and its ID e.g. `{{{< tweet user="SanDiegoZoo" id="1453110110599868418" >}}}`. In R Markdown, shortcodes need to be html escaped, refer to [the template](https://github.com/ropensci/roweb3/blob/HEAD/archetypes/Rmd/index.md) for an example.

If you want to quote a tweet and make it look more subdued, you can use a [block quote](#blockquotes) linking the tweet.
We no longer recommend embedding social media posts directly, as posts can always
be deleted and the context in the blog post is lost when that happens.

Instead, we recommend using a [block quote](#blockquotes) linking the post.
[Example](https://ropensci.org/blog/2021/02/03/targets/), [source](https://github.com/ropensci/roweb3/blob/0528c5a9e0ea781dd78a9f70c1e49d034f39fd69/content/blog/2021-02-03-targets/index.md?plain=1#L35).

### Block quotes {#blockquotes}
Expand Down Expand Up @@ -427,8 +429,8 @@ Compare [raw markdown](https://raw.githubusercontent.com/ropensci/roweb3/HEAD/co
- 'rOpenSci' not 'ROpenSci'
- **Links and images**
- When adding rOpenSci links to your post, use relative instead of absolute URLs e.g. `/blog/` instead of `https://ropensci.org/blog/`.
- When linking to [rOpenSci packages](https://ropensci.org/packages/) use their docs.ropensci.org URL, e.g. https://docs.ropensci.org/drake/.
- Use [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) (not html) to add images, tweets, gists etc.
- When linking to [rOpenSci packages](https://ropensci.org/packages/) use their docs.ropensci.org URL, e.g. https://docs.ropensci.org/target/.
- Use [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) (not html) to add images, gists etc.
- In R Markdown wrap Hugo shortcodes between html preserve tags as shown in the [template](https://github.com/ropensci/roweb3/blob/HEAD/archetypes/Rmd/index.md).
- Instead of using html widgets (`DT`, `leaflet`, etc.), include a screenshot and use the `link` option of the [Hugo `figure` shortcode](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) to direct readers to an online version of the widget.
- Use informative [alternative text](#addimage) for all images.
Expand All @@ -450,7 +452,7 @@ If using the R Markdown template, knitting `index.Rmd` (RStudio knit button, or

You can use functions in the [roblog package to do some automated checks](https://docs.ropensci.org/roblog/articles/checks-guidance.html) on your post.

- `ro_lint_md()` to check and enforce use of complete alternative descriptions for image, of relative links to rOpenSci website, of [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) for tweets.
- `ro_lint_md()` to check and enforce use of complete alternative descriptions for image, of relative links to rOpenSci website, of [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes).
- `ro_check_urls()` to check for URLs that might be broken

### Author Checklist {#checklists}
Expand Down
2 changes: 1 addition & 1 deletion editor-meta.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ The blog editors don't necessarily have write access to the blog-guidance repo b

* Staff members can bypass review for tech notes but they can choose to request a review by blog editors.
* Staff members' blog posts should be scheduled together with the Community Manager.
* Staff members are responsible for creating the [discussion forum entry](#publish) for their own post and must [tweet from the rOpenSci Twitter account](#tweetpromo) (directly or via the Tweetdeck rOpenSci team) before tweeting from their personal account.
* Staff members are responsible for promoting their own posts from their personal account on Mastodon and/or LinkedIn tagging rOpenSci's accounts.
Loading

0 comments on commit 5a42bb4

Please sign in to comment.