Documentation site doesn't work about aruba HOT 13 OPEN

Having read through the linked issues from vcr/vcr#755 it's pretty clear to me that waiting for Cucumber Pro Cucumber Jam CucumberStudio is not a good option. I'm going to be looking at other options.

from aruba.

Hi there,

Has the documentation been down since late 2020? It still can't be accessed and, as a potential new user, I feel very wary of getting invested into the tool without it.

from aruba.

@mvz The documentation is one of the strongest points I like about BDD and Cucumber, as the project has always up to date and error free documentation.

I've used Aruba documentation website a lot in the past when working with it, to fully embrace all the needed features.

Yes, one can grep the feature files, but the documentation in the html format, with the search box, was one of "wow effect" points when demonstrating this technology to other colleges and peers.

Please considering this bug a high priority one.

from aruba.

I'm trying to get some info on what's going on here. If nothing comes out of that I'm going to explore alternatives.

from aruba.

Looks like it's still broken.

from aruba.

Aruba's older versions were hosted at relishapp; e.g. https://relishapp.com/cucumber/aruba/v/0-11-0/docs/configuration
@mvz Do you know why newer versions are not?

Even its not the solution for this issue, do you know a way to generate it locally? (more readable than cucumber -f html)

Thanks!

from aruba.

@mvz For reference, here's vcr's take on the same: vcr/vcr#755 a thread where we attempt to circle what can be done.

from aruba.

Thanks @olleolleolle! Anyone interested in what's going on should look at that issue and the issues linked from there.

@neomilium I don't know why Aruba doesn't use Relish. Aruba was already using cucumber pro when I became a maintainer. I think by that time Relish was already considered legacy. I haven't looked into generating the documentation locally yet since I always just leaned on cucumber pro.

from aruba.

Based on the discussion for VCR, I did some research and here are my findings up to now:

• GitBook looks pretty but it's another external service to rely on.
• mdBook is an alternative to GitBook that is open source and can be run locally
• gherkin2markdown can be used to convert the scenario's to markdown to be processed by mdBook, but the implementation is simple enough that it could be replaced if necessary.
• yard-cucumber is a nice idea but the project hasn't seen any updates since 2018 and only works with cucumber 2 and 3. I have looked into updating the code but the result wasn't great (see https://github.com/mvz/yard-cucumber/tree/update-dependencies)
• I have also tried cucumber's built-in HTML format, but the result is not suitable for use as documentation.

All in all, the most promising direction is converting the gherkin files to markdown and then using mdBook to create HTML from that.

from aruba.

@mvz I think you could add an interesting option to the list: cucumber supports a custom formatter as --format option.

Source cucumber --help:

FORMAT can also be the fully qualified class name of your own custom formatter. If the class isn't loaded, Cucumber will attempt to require a file with a relative file name that is the underscore name of the class name.Example: --format Foo::BarZap -> Cucumber will look for foo/bar_zap.rb. You can place the file with this relative path underneath your features/support directory or anywhere on Ruby's LOAD_PATH, for example in a Ruby gem.

To help to found a template, the built-in formatters are located in lib/cucumber/formatter in cucumber gem.
https://github.com/cucumber/cucumber-ruby/tree/master/lib/cucumber/formatter

from aruba.

• yard-cucumber is a nice idea but the project hasn't seen any updates since 2018 and only works with cucumber 2 and 3. I have looked into updating the code but the result wasn't great (see https://github.com/mvz/yard-cucumber/tree/update-dependencies)

@mvz I took a look at yard-cucumber as well. I haven't been motivated enough to actively try and update it myself but, for you or anyone else who was thinking about having a go at it, the gherkin portion of it could probably be swapped out with cuke_modeler, which works with every version of Gherkin to date. I made that gem specifically to be able to make other useful tools like this.

from aruba.

@dcominottim unfortunately, yes. Both how to generate nice HTML from the scenario's and where to host the results are open questions at the moment.

from aruba.

@mvz What ever happened to Relish as a resource for doing that?

from aruba.