cucumber / docs

Cucumber user documentation
https://cucumber.io/docs/installation/
MIT License
151 stars 530 forks source link

Links to fix #19

Closed plaindocs closed 7 years ago

plaindocs commented 7 years ago

Brain dump of links in sw-reorg which either need turning into proper markdown links [text](/path/to/file) or have the [[text]] removing.

Running grep "\[\[" in the content dir should give you an updated list.

wiki/cucumber-backgrounder.md
364:As with `Feature`, `Scenario` is used only for identification when reporting failures and to document a piece of the work. The clauses (*steps*) that make up a Scenario each begin with one of: Given, When, Then, And and But (and sometimes **\***). These are all [[Gherkin]] keywords / Cucumber methods that take as their argument the string that follows. They are the steps that Cucumber will report as passing, failing or pending based on the results of the corresponding step matchers in the step_definitions.rb files. The five keywords (and **\***) are all equivalent to one another and completely interchangeable.
489:Always keep in mind that Cucumber is simply a DSL wrapper around the Ruby language whose full expressiveness remains available to you in the step definition files (*but not in the feature files*). On the other hand, do not lose sight that every step called as such in a step definition file is first parsed by [[Gherkin]] and therefore must conform to the same syntax as used in feature files.

wiki/autotest-integration.md
57:If you get an error like `When using several—format options only one of them can be without a file (RuntimeError)` when running features with autospec, you are probably accidentally requiring 'spec'. Read about the solution on [[Troubleshooting]].

implementations/jvm.md
14:Please see the [[general reference]] for features that are
73:- [[Android Runner]]
149:The [JUnit Runner](#junit-runner) and [[Android Runner]] can also pick
187:Usage: java cucumber.api.cli.Main [options] [[[FILE|DIR][:LINE[:LINE]*] ]+ | @FILE ]
320:If you prefer to use a [[Data Table]] to define a list you can do that too:

implementations/ruby/ruby-on-rails.md
83:If you're on an OS that supports fork we recommend you use [[Spork and --drb]] as this lets you start cucumber faster:
163:Remember that you need AUTOFEATURE=true for autospec to include cucumber features. See [[Running Features]] and \[\[Autotest Integration]] for more info.
176:There are two special [[tags]] you can use to change how Cucumber runs your scenarios
180:By default all scenarios will run within a database transaction that is rolled back at the end. However, scenarios tagged with `@no-txn` will run **without** a transaction. This can be useful when you have to deal with [[Browsers and Transactions]]. Beware that this will leave data in your database after that scenario, which can lead to hard-to-debug failures in subsequent scenarios. If you use this, we recommend you create a Before block that will explicitly put your database in a known state, for example using [DatabaseCleaner](https://github.com/bmabey/database_cleaner)

implementations/ruby/calling-steps-from-step-definitions.md
63:Sometimes you want to call a step that has been designed to take [[Multiline Step Arguments]], for example:

implementations/php.md
95:The per feature and per table approach can be accomplished using [[hooks]].

about/blog-posts.md
10:Please add any helpful blog posts that you have found or written about all things Cucumber. Also see [[Related Tools]].

about/get-in-touch.md
41:- And finally, tell us how to reproduce the error, as described on the [[Contributing]] page.

about/contributing.md
12:Before you [[get in touch]] and file a ticket in the issue tracker, make sure you have tried the latest gem. Also try to \[\[install]] the latest code from Git. This way you don't waste the developers' time by reporting a bug that has already been fixed.
18:The only way we can fix a bug is to reproduce it first. If reproducing the bug requires setting up a project, please write a [[Cucumber Feature]] that demonstrates the bug. When you have done that, mention it in your ticket or send a pull request.
24:Start by creating a ticket. Then, create a [[Cucumber Feature]] and start implementing it. It also helps if you add RSpec specs for the low level code.

gherkin/gherkin-reference.md
10:the [[documentation overview]] for links to platform-specific documentation.
194:You can also use placeholders in [[Multiline Step Arguments]].

gherkin/feature-introduction.md
14:(or localized equivalent; Gherkin is localized for [[dozens of languages|Spoken

cucumber/step-definitions.md
44:Also check out [[Multiline Step Arguments]] for more info on how to pass entire tables or bigger strings to your step definitions.

cucumber/cucumber.yml.md
20:Defining a template requires a name and then the command-line options that you want to execute with this profile. The example above generates two profiles: the first, named `html_report`, with a list of command-line options that specify new output formats and a second, named `bvt` which executes all features and scenarios [[tagged|Tags]] with @bvt.
80:[[Environment Variables]] can be used in the profile argument list for a profile as you would normally specify one on the command-line.
95:[[Integration with Autotest|Autotest-Integration]] uses two profiles `autotest` and `autotest-all`. These profiles should be reserved for that service.

cucumber/running-features.md
70:Maven and Ant are described in [[JRuby and Java]]. MSBuild and Nant should be under [[IronRuby and .NET]]. Anything else - please contribute to this wiki!

cucumber/state.md
22:[[Before Hook]] to remove all data *before* a scenario starts.
24:This is usually better than using an [[After Hook]] as it allows
36:You simply tell Cucumber to start a transaction in a [[Before Hook]] and roll it back
37:in an [[After Hook]].
40:[[Tagged Hooks]] using a tag named `@txn`.
42:To enable it you have to tag every [[Feature]] or [[Scenario]]
58:The [[cucumber-spring]] module contains `@txn` hooks in the `cucumber.api.spring` package.
60:This package isn't on your [[glue path]] by default, so you have to add it yourself in your
61:[[Configuration Options]].

cucumber/step-organization.md
11:How do you name step definition files? What to put in each step definition? What **not** to put in step definitions? Here are some guidelines that will lead to better scenarios. If you are new to steps and the general syntax, please read [[Feature Introduction]] first.
plaindocs commented 7 years ago

Down to these thanks to @mlvandijk :

Several links still need to be added (or removed), but I couldn't find anything to link to:

* implementations/jvm.md:
[[Android Runner]] - 4x
[[Data Table]] - 2x
* gherkin-reference.md
[[Multiline Step Arguments]] - 2x
* cucumber/step-definitions
[[Multiline Step Arguments]] 
* ruby/calling-steps-from-stepdefinitions
[[Multiline Step Arguments]]
mlvandijk commented 7 years ago

Fixed by PR #27