pre-release notes & description

[F-said]

What needs documentation and what will each item entail?

Create pre-release notes describing relevant features and functionality for contributors (and some savvy researchers).

• create draft of pre-release notes of features (non-technical language preferred)
• create discrete instructions for contributors in contributing.md
• a quick get-started section is implemented for users
• ensure stability for contributors (issue Test stability of pepper for contributors before 1st release  #281)

Need to pass it by a second pair of eyes before bringing it out to the world

[F-said]

Tag

v0.1-alpha

Title

PEPPER 🌶️ v0.1 Pre-release Szegedi 2021-31-8

Body

Overview
Pre-release Szegedi is now stable for contributors! Consult documentation and links below to get started.

Features

• 🧠 Reliably preprocess EEG data with a fully integrated & parameterized pipeline.
• 🐳 Build container images for easy development.
• 🐙Run on HPC clusters using prepared scripts.
• 🧪Run a comprehensive test-suite on all software features.

Bug-fixes
None for this release.

Documentation

• To get started on contributing, check out our CONTRIBUTING.md file!
• To learn more about the motivation behind this pipeline, take a look at our README.md!

Contact
The NDClab is an open-science laboratory that values contributors from any and all backgrounds. Visit our GitHub to contribute to code, learn about the science, and submit issues.

[F-said]

@DMRoberts @jessb0t @georgebuzzell

The above describes our first stable release for contributors, please provide feedback at your convenience.

I figure each release can have a pepper name, there seems to be a lot to go through: https://www.cayennediane.com/big-list-of-hot-peppers/

[F-said]

Changed Serrano to Sweet Bell for less spiciness

[F-said]

https://forknplate.com/2017/11/26/mildest-hottest-guide-peppers/

[F-said]

Changed Sweet Bell to Szegedi for cooler pepper name

[jessb0t]

@F-said I think this content is awesome, and very much the kind of public-facing tone that we are trying to build for the lab! Here are my very minor typographical suggestions:

Title
Correct date format to 2021-08-31

Overview
I would add "Please" before "Consult", just for tone.

Features:

• I think hyphens often help make reading easier, so I would suggest "pre-process" and "fully-integrated".
• I suggest avoiding the ampersand (&) and writing out "and".

Bug-fixes
Since this is a heading, I would capitalize both words and remove the hyphen: "Bug Fixes".

[F-said]

Thank you @jessb0t !

Incorporating edits to new prerelease below

[F-said]

Tag

v0.1-alpha

Title

PEPPER 🌶️ v0.1 Pre-release Szegedi 2021-08-31

Body

Overview
Pre-release Szegedi is now stable for contributors! Please consult the documentation and links below to get started.

Features

• 🧠 Reliably pre-process EEG data with a fully-integrated and parameterized pipeline.
• 🐳 Build container images for easy development.
• 🐙Run on HPC clusters using prepared scripts.
• 🧪Run a comprehensive test-suite on all software features.

Bug Fixes
None for this release.

Documentation

• To get started on contributing, check out our CONTRIBUTING.md file!
• To learn more about the motivation behind this pipeline, take a look at our README.md!

Contact
The NDClab is an open-science laboratory that values contributors from any and all backgrounds. Visit our GitHub to contribute to code, learn about the science, and submit issues.

[F-said]

Need to consult https://www.python.org/dev/peps/pep-0440/ for release standards

[F-said]

Need to merge in documentation to main to run docker as root to resolve write error