Wanted: Cucumber Documentation Champion!
55 views
Skip to first unread message
Matt Wynne
Jun 9, 2016, 9:29:38 AM6/9/16
to cukes
Hi all,
We’re looking for a volunteer (or volunteers!) to join the core team with the express responsibility for improving the documentation for Cucumber users.
We’ve had several false starts at this over the years - a wiki, the markdown pages at http://cucumber.io/docs for example. None of these have ever really got off the ground, and we know the current state of the documentation is making it hard for people to learn Cucumber and BDD.
This is an opportunity for you to become part of the core team, and to learn more about Cucumber as you pull together all the documentation we already have, organise it, present it back in a useful way, and fill the gaps either by writing new documentation yourself, or delegating that to other people within or outside the core team. You’ll need to be comfortable writing technical documentation in English, and happy writing in markdown or asciidoc syntax. Knowing HTML / CSS / Ruby is a bonus but not necessary.
You’ll be given all the support you need from the core team and Cucumber Ltd, including video calls / pairing with us to throw ideas around or hack on something.
If this sounds like you, please write back to ma...@cucumber.io off-list. Thanks!
The Cucumber logo is the intellectual property of Cucumber Ltd, a limited company registered in Scotland, number 456793.
UK Headquarters: Cucumber Ltd, Drumsyniebeg, Lochgoilhead, Cairndow, Argyll, PA24 8AN UK.
CONFIDENTIALITY NOTICE: The information in this e-mail is confidential and privileged; it is intended for use solely by the individual or entity named as the recipient hereof. Disclosure, copying, distribution, or use of the contents of this e-mail by persons other than the intended recipient is strictly prohibited and may violate applicable laws. If you have received this e-mail in error, please delete the original message and notify us by email immediately. Thank you. Cucumber Ltd.
Aslak Hellesøy
Jul 1, 2016, 8:44:40 AM7/1/16
to Cukes
TL;DR We've decided to use GitBook for the Cucumber docs, and you're all welcome to help with docs.
The Cucumber documentation is currently scattered around a few places:
* https://github.com/cucumber/cucumber/wiki (the original, and very outdated docs)
* https://cucumber.io/docs (an effort we started little over a year ago - quite incomplete)
* Various Markdown documents in the various cucumber implementations
Our vision is to retire all of that old documentation, salvage the parts that are valuable and host it all in the main Cucumber git repository [1]. We'll be using GitBook [2] as an authoring and publishing platform. The new documentation is up and running [3], but as you see it's rather incomplete - apart from the outline (SUMMARY.md).
People who contribute regularly will enjoy some benefits:
* Free Cucumber School videos
* Invitation to our annual invite-only weekend meetup for the Cucumber core team
* Your name/bio/photo on the Team page (yet to be written!)
* Stickers and a Cucumber tee-shirts
Here is how to get started: Start with something simple. Pick one of the topics under "Cucumber Reference" such as Feature, Scenario, Tags etc. Look up the old documentation and try to rewrite it according to the guidelines [4].
It might be a good idea to announce what you're currently working on to avoid duplicate effort. We'll use use chat (https://gitter.im/cucumber/docs) and/or email (cukes...@googlegroups.com) to discuss.
Let's write some excellent docs and bury that old crufty stuff!
All the best,
Aslak Hellesøy
Eric Kessler
Jul 1, 2016, 10:10:54 AM7/1/16
to Cukes
Will this new documentation be used in conjunction with or as a replacement for the Relish docs (https://www.relishapp.com/cucumber/cucumber/docs)?
Eric K
aslak hellesoy
Jul 1, 2016, 10:14:55 AM7/1/16
to cu...@googlegroups.com
On Friday, 1 July 2016, Eric Kessler <morr...@gmail.com> wrote:
Will this new documentation be used in conjunction with or as a replacement for the Relish docs (https://www.relishapp.com/cucumber/cucumber/docs)?
When we launch Cucumber Pro (successor of Relish) later this year we might start publishing the docs there instead of GitBook's hosting service.
Aslak
--Eric K
Posting rules: http://cukes.info/posting-rules.html
---
You received this message because you are subscribed to the Google Groups "Cukes" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cukes+un...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply all
Reply to author
Forward
0 new messages