Help bring content to the new cukes.info website
aslak hellesoy
Over the weekend I wrote a small webapp for the new web site for
http://cukes.info.
You can test out some of the content here:
http://hollow-flower-8501.heroku.com/example
There isn't much valuable content yet - I have focused on the app
itself until now.
The new web site will serve as a cross-platform reference
documentation for all of the Cucumber implementations:
* cucumber
* cucumber-jvm
* cucumber-js
* maybe specflow
I'm also considering pages for "official" cucumber sub-projects such
as cucumber-rails, aruba, cucumber-tmbundle etc.
To give you an idea of what I'm aiming for - when you go to the
/stepdefinitions page, you will get a page that explains Step
Definitions, but in a way that doesn't favorise a particular
programming language. The text will be written in such a way that it
makes sense regardless of programming language, and all code examples
will have tabs that let you switch to the one you're interested in
(Ruby, Java, JavaScript, Python, Groovy, Clojure, Scala, etc)
The site has syntax highlighting support for all relevant programming
languages, including gherkin in all of its i18n translations. The plan
is to migrate the good parts of the wiki
(https://github.com/cucumber/cucumber/wiki/_pages) over to the new
site.
This isn't a matter of copy-paste, since the goal is to make the
documentation work across implementations. There is also a lot of
poorly-written (and incorrect) information on the Wiki.
I'm not going to do it all myself, so I'm reaching out to everyone to
help get this done. The docs will be contributed like code -
fork-commit-pullrequest-merge. We have outgrown the wiki model.
The source is here: https://github.com/cucumber/cukes.info
The issues are here: https://github.com/cucumber/cukes.info/issues
The design is based on Twitter Bootstrap, and the site is currently
looking very generic. I'd obviously like to make it look more branded.
Give us a shout if you want to help!
Aslak
Robert
Aslak Hellesøy
--
You received this message because you are subscribed to the Google Groups "Cukes" group.
To view this discussion on the web visit https://groups.google.com/d/msg/cukes/-/zDfc9-N7kl8J.
To post to this group, send email to cu...@googlegroups.com.
To unsubscribe from this group, send email to cukes+un...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/cukes?hl=en.
Robert
David Kowis
Hash: SHA1
On 02/13/2012 04:37 AM, aslak hellesoy wrote:
> Hi guys,
>
> Over the weekend I wrote a small webapp for the new web site for
> http://cukes.info. You can test out some of the content here:
> http://hollow-flower-8501.heroku.com/example There isn't much
> valuable content yet - I have focused on the app itself until now.
Hey. I was looking into building some documentation for the
cucumber-jvm stuff and so I found this finally in my large pile of emails.
I checked out the demo site and there wasn't a whole lot there, but I
thought I'd mention something I discovered recently.
Jekyll. It runs pages.github.com and generates static content,
syntatically highlighted, and all sorts of good stuff.
Also, there's an extension to it called octopress that bakes in all
the blog stuff (not saying we need a blog, but it might be a good
starting point).
Anyway, I thought I'd ask if there was any reason it needed to be a
dynamic application, since you're storing it in git already, and using
markdown to generate the content.
If it's too much work to switch, or switching is undesired, that's not
a big deal either, I'm flexible :) Just recommending because static is
always faster than dynamic, and it could be advantageous :)
Either way, I'll work on documents for cucumber-jvm based on what I know.
- --
David
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQGcBAEBAgAGBQJPbLZBAAoJEMnf+vRw63ObejoMAJM+/0ewaH7DC2J1tH/lOutH
4Jsq/YRMpz8qOYznnT4OvJhtz8t4HiL4D72vR2Wq43hf6HU/l9g2QEyahLv0HUf8
PSHX7LE4bKDCEOLEzcY+nBXd1x97Rpq6Y9fnijb9Uf+s/QEZhToVCq3CbhFRSrc7
ssYnrzezA46o5w/gP523dqyjRaUjEhGtZFKjHmDogrRo+CxVqkxWNCa2ufNjZ5m8
qQPGjO9UoeXvFAUAUx2Wi9nfCKYuBQbxjKexablGk6S5oelRYxA8XJwvuurHDNKH
59hAe9olOuKlW5X/0V+/BIMl3I9IJ5066MBKxcaVNMhEzz48auEJbqsy+cBKwfb8
ZNa8uZPkJqU0Ycw53NH+fukYIB2YmgURDVRj6qQEU54dBod1FhZ+8nygvaUQk9s7
3ow9xzIfaiNun40FbKpeLILrWxyVlQxXpPToaVmAyNxaCWnnshhBy52DACbNYnOW
1JeSL2bdYjv/k9P/4bkX1F/i95Qi/MToET45E6Ns2A==
=TG8j
-----END PGP SIGNATURE-----
Aslak Hellesøy
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> On 02/13/2012 04:37 AM, aslak hellesoy wrote:
>> Hi guys,
>>
>> Over the weekend I wrote a small webapp for the new web site for
>> http://cukes.info. You can test out some of the content here:
>> http://hollow-flower-8501.heroku.com/example There isn't much
>> valuable content yet - I have focused on the app itself until now.
>
> Hey. I was looking into building some documentation for the
> cucumber-jvm stuff and so I found this finally in my large pile of emails.
>
Glad you saved it!
> I checked out the demo site and there wasn't a whole lot there, but I
> thought I'd mention something I discovered recently.
>
> Jekyll. It runs pages.github.com and generates static content,
> syntatically highlighted, and all sorts of good stuff.
>
I know about Jekyll. Tried it. Doesn't fit the bill, I want more
control over the generated HTML. Especially since it will be a site
for all the Cucumber impl, with some dynamically changing contents,
depending on programming language/framework/build tool.
> Also, there's an extension to it called octopress that bakes in all
> the blog stuff (not saying we need a blog, but it might be a good
> starting point).
>
> Anyway, I thought I'd ask if there was any reason it needed to be a
> dynamic application, since you're storing it in git already, and using
> markdown to generate the content.
>
The main reason is that there is no build step. And easier to
Implement (IMO)
> If it's too much work to switch, or switching is undesired, that's not
> a big deal either, I'm flexible :) Just recommending because static is
> always faster than dynamic, and it could be advantageous :)
>
That's only true in a world without caches.
> Either way, I'll work on documents for cucumber-jvm based on what I know.
>
Awesome. I actually wrote a bit of docs last night, I'm pretty much
done with the pre-1.0.0 work for Cucumber-JVM. Don't remember if I
pushed. I'll add some empty pages to make it easier to know what needs
to be documented. Off the top of my head: DI, Hooks, Gherkin,
Installation, Web testing, Cucumber-Rails, CI, CLI.
Aslak
> - --
> David
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.12 (GNU/Linux)
> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
>
> iQGcBAEBAgAGBQJPbLZBAAoJEMnf+vRw63ObejoMAJM+/0ewaH7DC2J1tH/lOutH
> 4Jsq/YRMpz8qOYznnT4OvJhtz8t4HiL4D72vR2Wq43hf6HU/l9g2QEyahLv0HUf8
> PSHX7LE4bKDCEOLEzcY+nBXd1x97Rpq6Y9fnijb9Uf+s/QEZhToVCq3CbhFRSrc7
> ssYnrzezA46o5w/gP523dqyjRaUjEhGtZFKjHmDogrRo+CxVqkxWNCa2ufNjZ5m8
> qQPGjO9UoeXvFAUAUx2Wi9nfCKYuBQbxjKexablGk6S5oelRYxA8XJwvuurHDNKH
> 59hAe9olOuKlW5X/0V+/BIMl3I9IJ5066MBKxcaVNMhEzz48auEJbqsy+cBKwfb8
> ZNa8uZPkJqU0Ycw53NH+fukYIB2YmgURDVRj6qQEU54dBod1FhZ+8nygvaUQk9s7
> 3ow9xzIfaiNun40FbKpeLILrWxyVlQxXpPToaVmAyNxaCWnnshhBy52DACbNYnOW
> 1JeSL2bdYjv/k9P/4bkX1F/i95Qi/MToET45E6Ns2A==
> =TG8j
> -----END PGP SIGNATURE-----
>
> --
> You received this message because you are subscribed to the Google Groups "Cukes" group.
David Kowis
Hash: SHA1
On 03/23/2012 02:18 PM, Aslak Helles�y wrote:
> On Mar 23, 2012, at 17:43, David Kowis <dko...@shlrm.org> wrote: On
> 02/13/2012 04:37 AM, aslak hellesoy wrote: I checked out the demo
> site and there wasn't a whole lot there, but I thought I'd mention
> something I discovered recently.
>
> Jekyll. It runs pages.github.com and generates static content,
> syntatically highlighted, and all sorts of good stuff.
>
>
>> I know about Jekyll. Tried it. Doesn't fit the bill, I want more
>> control over the generated HTML. Especially since it will be a
>> site for all the Cucumber impl, with some dynamically changing
>> contents, depending on programming language/framework/build
>> tool.
Okay, fine by me :)
> If it's too much work to switch, or switching is undesired, that's
> not a big deal either, I'm flexible :) Just recommending because
> static is always faster than dynamic, and it could be advantageous
> :)
>
>> That's only true in a world without caches.
True, but I figured it's probably simpler to not have to deal with any
caching at all, than to ensure that caching expires correctly and what
parts can be cached. It's probably an argument that can go in circles
forever :)
>
>> Awesome. I actually wrote a bit of docs last night, I'm pretty
>> much done with the pre-1.0.0 work for Cucumber-JVM. Don't
>> remember if I pushed. I'll add some empty pages to make it easier
>> to know what needs to be documented. Off the top of my head: DI,
>> Hooks, Gherkin, Installation, Web testing, Cucumber-Rails, CI,
>> CLI.
Okay, I'll wait until more things are pushed so that I don't end up
duplicating efforts.
- --
David
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQGcBAEBAgAGBQJPbNSXAAoJEMnf+vRw63Ob8X0MAKYpT0s/5KzabzcU8CXQKLUi
reVpJ/ptXglq2Vglif1MIdPq23maJaMyz2AuOcogJSkDp9hQb78HVKKVWXR5HT/x
6J+G8+WKEpmvyPnfDjqLz90biUwTBErZ84eiWq+wQPy7OoZEFvEJ3xhuo7NdR4Ub
FfsM9Mcndvwe7PPrnInz7mwVrcUJP40hV2mJF1PJW47ylZvhIGLZ8bPmxTas+pZi
shx3Q3AnBQf2xJtj5cCu1g81fxZuZZwy/XBjLnZp4KWyJY2PC21c41+lertAqOT6
n4B3feObrGvjuN43ZNwdSZHhvKUh0KkgWzlCVd8OVfQ99onMsD5S+oVcdjzIEIkz
g929z5Rn9nQwmxHUoilek9dp1iC05Pu8c8jnk9fuY7VIfB+NQaakNXSFdNDL3rg9
UCbTwIwpf6EDm5Qft+DmvXYeThpUuKb4Pm/ePTksFKjwaTHU26aIYEMd0vl0ZdNO
fnVA2RvviiMFHSyVJLR9/x39aHA8mqRZQZM6q9y+MA==
=45G9
-----END PGP SIGNATURE-----
Robert
> - --
> David
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.12 (GNU/Linux)
> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
>
> iQGcBAEBAgAGBQJPbLZBAAoJEMnf+vRw63ObejoMAJM+/0ewaH7DC2J1tH/lOutH
> 4Jsq/YRMpz8qOYznnT4OvJhtz8t4HiL4D72vR2Wq43hf6HU/l9g2QEyahLv0HUf8
> PSHX7LE4bKDCEOLEzcY+nBXd1x97Rpq6Y9fnijb9Uf+s/QEZhToVCq3CbhFRSrc7
> ssYnrzezA46o5w/gP523dqyjRaUjEhGtZFKjHmDogrRo+CxVqkxWNCa2ufNjZ5m8
> qQPGjO9UoeXvFAUAUx2Wi9nfCKYuBQbxjKexablGk6S5oelRYxA8XJwvuurHDNKH
> 59hAe9olOuKlW5X/0V+/BIMl3I9IJ5066MBKxcaVNMhEzz48auEJbqsy+cBKwfb8
> ZNa8uZPkJqU0Ycw53NH+fukYIB2YmgURDVRj6qQEU54dBod1FhZ+8nygvaUQk9s7
> 3ow9xzIfaiNun40FbKpeLILrWxyVlQxXpPToaVmAyNxaCWnnshhBy52DACbNYnOW
> 1JeSL2bdYjv/k9P/4bkX1F/i95Qi/MToET45E6Ns2A==
> =TG8j
> -----END PGP SIGNATURE-----
>
> --
> You received this message because you are subscribed to the Google Groups "Cukes" group.
> To post to this group, send email to cu...@googlegroups.com.
> To unsubscribe from this group, send email to cukes+unsubscribe@googlegroups.com.
> To unsubscribe from this group, send email to cukes+unsubscribe@googlegroups.com.
Aaron VonderHaar
Do you have a general outline in your head for how the new site is
going to be organized, or are you looking for contributions toward
that as well?
I'd like to start filling in info about getting started with
cucumber-jvm as I update several of my projects to use it, but I'd
like to stick it in the right place so it can be merged easily.
Cheers,
--Aaron V.
> --
> You received this message because you are subscribed to the Google Groups "Cukes" group.
> To post to this group, send email to cu...@googlegroups.com.
> To unsubscribe from this group, send email to cukes+un...@googlegroups.com.
aslak hellesoy
<gruen0...@gmail.com> wrote:
> Hi Aslak,
>
> Do you have a general outline in your head for how the new site is
> going to be organized, or are you looking for contributions toward
> that as well?
>
I have an outline in my head. I'll add some placeholder pages (.md
files) to make it easier for you guys to gtet started. I'll announce
here when it's ready.
Aslak