Corrected: External comms updated #92
Conversation
|
pre-commit.ci autofix |
|
@lwasser this is ready for review! it was easier to make a new PR, as I got stuck in a rebase loop that started pulling in unrelated files 🙈 I've checked it locally, and the build looks good. there should be three files to review. I believe I've pulled everything over from the last review (minus the |
|
|
||
| These posts are all structured as blog posts, using appropriate heading and subheading formats within LinkedIn. In fact, all of our newsletters are first published on the pyOpenSci blog, and should follow the same tone and format. | ||
|
|
||
| When a newsletter post is a re-post from the pyOpenSci blog, it's important to include text and a link back to the original blog post, indicating where the post was originally published. This prevents link cannibalisation, where different links with the same content compete for keyword rankings. We want all keyword rankings to be directed back to the pyOpenSci website wherever possible. |
There was a problem hiding this comment.
@kierisi don't we also want a canonical meta element in the html for this instance? So for eric's post we'd want to add a canonical tag to the html.
There was a problem hiding this comment.
that's a good point, I hadn't considered publishing other people's content on our website and will get this updated.
|
|
||
| Because pyOpenSci is still in the early days of its newsletter, our success metrics are focused primarily on growth and engagement rate. We are currently aiming for: | ||
|
|
||
| * 1.0% (or higher) monthly increase in newsletter subscribers |
There was a problem hiding this comment.
Please add where this data comes from and how it's tracked.
|
|
||
| ## Zenodo | ||
|
|
||
| Zenodo is a general-purpose research repository where any research output can be shared by its users, where pyOpenSci maintains a [community group](https://zenodo.org/communities/pyopensci?q=&l=list&p=1&s=10&sort=newest). When pyOpenSci staff give a presentation, they will update the community group with their talk materials. In addition, when community members give presentations, they have the option of adding them to the pyOpenSci Zenodo community group. |
There was a problem hiding this comment.
A few important things to add
- pyOpenSci uses Zenodo as a way to provide citable entities for its GitHub org repos. (it provides DOI's but they aren't cross-ref doi but still citable). we use it for most of our repos and add the citation badge to the readme of each repo. then we add the badge to the home page of content that is being tracked in zenodo.
When there are major updates to content such as the packaging guide, we create a new release and zenodo provides and updated DOI associated with those commits. .
we also have a zenodo communiy that people can add their presentations, blog posts, or any content really to. This allows the community member (or pyopensci staff) to gain a citable DOI for the element deposited in the community but also they still own the addition.
the community is moderated by pyOS staff admins. So anyone can suggest and addition but we moderate what is added.
| All package authors, maintainers (and users) of a pyOpenSci-accepted package are welcome and encourage to submit a blog post (or series of blog posts) about their review experience and/or the use of the package. When submitting your blog post, please include the following YAML elements: | ||
|
|
||
| ``` | ||
| layout: single |
There was a problem hiding this comment.
I just added a last_modified yaml element and a script (that is not in our ci yet) that updates the last updated date for any blog post that we add (or event). It just needs to have last_modified as a key in the yaml.
it's a bash script. so in theory if someone runs that locally the last_updated key will be updated and the bottom of the page last_updated element will also get updated!
please add that key here and add a myst note about the bash script here as well.
https://github.com/pyOpenSci/pyopensci.github.io/blob/main/scripts/date-updated.sh
there are instructions for running it at the top of the script.
|
pre-commit.ci autofix |
Learning some hard lessons about GitHub 😅
This PR replaces #79 and should incorporate all of the PR review feedback except for the addition of a link to an
htmlproofersection. I'll set that up in a separate PR and once merged, will patch it into the handbook section here.