PyOpenSci Blog Guidelines

• Post length: min 300, max 700
  A recommended range of words limit.

• Image requirements: min 1, máx 3
  Maximum 3 images that could be related to the code or results or the project logo. Add reference/citation for the images used.

• Search Engine Optimization

The PyOpenSci blog provides an opportunity to make your package and work more visible to the community. To do this, we suggest you consider including words that you would want someone to use to find your tool, in the title of your blog, the url and the headers.

Given all of the pyopensci tools are python focused, it is ideal to include the word Python in both the title and the permalink (the url).

Examples:

Permalink Examples

• GOOD: permalink: /posts/pandera-dataframe-validation
• BETTER: permalink: /posts/pandera-python-pandas-dataframe-validation

Blog Title Examples

GOOD: data validation with pandera: This is a good title however would this title help someone find this post? It's more likely that someone might search for words like pandas and python and validation.

BETTER: Validate Data in Pandas DataFrames in Python
Here, we've added a few more keywords that someone might search for when looking for a data validation tool.

Page Heading Examples

Add more here..

• Guidelines on links:

• Only include links to pages related to the project being discussed. These links might include the repo page (github, gitlab, bitbucket, etc), documentation page, binder for a notebook related to the project, etc*

• Keywords: min 1, max 5 (words or compound words)
  Allowed between 1 and 5 words/compound words separated by ;, e.g. Python; Data Analysis; …

• Package information:

  • it is recommended that the text contains the following project information (it doens't need to be in a list, it could be distributed in the text).
    • package name
    • repo or documentation or home page url
    • community channel, if it corresponds
    • license

• Format: MarkDown
  Check this basic tutorial if you need any help https://www.markdownguide.org/basic-syntax/.

• File name:
  the filename should be written without white spaces and words could be separated by dash, e.g.: pyopensci-pandera-review.md or pandera-the-second-package-in-pyopensci.md

• YAML HEADER:

---------
title:
excerpt:
author: 
categories:
---------

example:

---------
title: "Welcome to pyopensci"
excerpt: "short description 1-2 sentences about the post here. the more descriptive the better."
author: "name here"
categories:
  - package-review
---------

• Repository:
  Each new proposal for a blog post should be submitted to https://github.com/pyOpenSci/pyopensci.github.io. The blog post file should be stored at /_posts folder.