We have a lot of external contributors.
We don't want to alienate them by taking credit.

On CI the step switch off telemetry is failing.

Gauge is installed successfully. Language runners are not yet installed.

https://app.wercker.com/sguptatw/gauge_ci/runs/build/596c6fb93b6e52000123d20f?step=596c6fbc39a67000013c3746

From @sguptatw on February 15, 2017 12:26

Documentation for understanding the behaviors of ParseErrors and Warnings. How do these affect statistics.

Copied from original issue: getgauge/documentation#77

From @sguptatw on April 1, 2016 23:56

Renaming the parameter is not renaming the usages inside the method.

Define a spec with parameter. Add code which uses the parameter in the java file.
Shift-f6 on the spec. Rename the parameter name to something else. Now go to the code.
The java file still has usages of the old variable name and hence there is compilation issue.

However this is by design. The renamed parameter is considered as a different parameter. Therefore the usage of the old parameter name has to be fixed manually to solve the compilation issue.

Copied from original issue: getgauge/documentation#35

Hey, I've gain some intrest writing a plugin myself, and after a search in the docs, I could'nt manage to find any documentation what so ever as to where should I start. I would love some guidance and even more if it will be added to the docs. Thanks!

From @navyakanu on September 22, 2015 6:2

Under Section 11.1.1 Gauge IntelliJ Idea Plugin Features (6. Run Configurations) there are no details in the video for editing configurations with tags and parallel execution and the video displays only environment settings among the 4 points which is confusing

It would be more helpful if some options which are explained in detail for command line usage for gauge (like log customisation like setting up log-level in program arguments) if mentioned for IntelliJ IDE in section 11.6 Run Configuration

Kindly mention that concept should be written (rather called) in spec file (Section 2.5) like step which would be more easy to understand (this may not be self explanatory)

Copied from original issue: getgauge/documentation#20

From @sguptatw on August 17, 2016 0:15

Refactoring documentation is not present in Visual Studio features
Formatting documentation is not present in Visual Studio features
For Parallel execution it will be good if we can add a link to the existing article and mention there is support from the command line.
Will also be helpful if the documentation has content links like the one in IntelliJ.

Copied from original issue: getgauge/documentation#66

From @uzmar on September 3, 2015 6:25

It will be more clear to user to download all required components if gauge architectural diagram is available with brief explanation

Copied from original issue: getgauge/documentation#8

From @apoorvam on March 3, 2016 7:11

This should have most common troubleshoot steps like increasing the “runner_connection_timeout” in gauge.properties etc.

Copied from original issue: getgauge/documentation#33

From @sguptatw on December 13, 2016 9:25

To have a series of content - video, text which would address one aspect at a time.
This should cover the existing feature set. When a new feature is added, this section needs to be updated.

Copied from original issue: getgauge/documentation#74

The documentation of the zip file mentioned in the docs is not applicable to the Windows OS.

From @kashishm on April 6, 2016 5:34

Dynamic params can be used at two places:

• Table Driven Execution
• Concepts

Copied from original issue: getgauge/documentation#37

Expected behavior
Should not get errors while working with VSCode

Actual behavior

15:22:10.515 <-- notif: textDocument/publishDiagnostics: {"uri":"file:///c%3A/work/getgauge/gauge-lsp-tests/specs/codelens/findUsages.spec","diagnostics":[{"range":{"start":{"line":3,"character":0},"end":{"line":3,"character":10000}},"severity":1,"message":"write tcp 127.0.0.1:63152-\u003e127.0.0.1:63160: wsasend: An existing connection was forcibly closed by the remote host."},{"range":{"start":{"line":7,"character":0},"end":{"line":7,"character":10000}},"severity":1,"message":"write tcp 127.0.0.1:63152-\u003e127.0.0.1:63160: wsasend: An existing connection was forcibly closed by the remote host."}]}

Steps to replicate

• Yet to find a way to consistently replicate this.

Version

Gauge version: 0.9.8.nightly-2018-01-19
Commit Hash: 0c66ca4

Plugins
-------
js (2.1.1.nightly-2018-01-16)
ruby (0.4.3.nightly-2018-01-18)
screenshot (0.0.1)
xml-report (0.2.0)

From @sguptatw on April 6, 2016 3:38

Getting started in 3 steps should generic or talk about other language supported as well.

Copied from original issue: getgauge/documentation#36

Current behavior

Searching for a text on the documentation site returns the result in rst format that's difficult to read.

Expected behavior

Return text results, without rst syntax.

https://docs.getgauge.io/using.html#html-preview-tab should be updated

From @sguptatw on February 28, 2017 8:59

Additional Properties of maven and gradle

This gives the wrong usage.

Copied from original issue: getgauge/documentation#78

From @harinee on March 21, 2016 14:5

This is in regard to the documentation at:
http://getgauge.io/documentation/user/current/specifications/parameters.html

• Under 'special parameters' there is an incomplete line as "The different special parameter types are:". No examples are cited.
• I think table-driven execution should have a reference here. It is a different way of passing parameters which execute the steps in a loop. Ref: http://getgauge.io/documentation/user/current/execution/table_driven_execution.html

Copied from original issue: getgauge/documentation#34

Remove the windows installer documentation. Add the single binary doc details (add to path)

The website also has the installation details which has to be updated.

Observed on Write Specifications. The Code-block styles are broken

Furthermore, the Step with table is another heading. This style also needs to be looked at.

Usage of Html-report generation from saved execution data to be documented

The uninstallation path mentioned in the docs is rm -rf /usr/local/bin/gauge /usr/local/share/gauge /usr/local/share/gauge_screenshot ~/.gauge

This should be updated with the latest folders as well

1. When I look for some info in Google like
   how to use Tags with specifications Gauge the old document links are getting listed.

2. The old urls are not getting redirected properly eg: -getgauge.io/documentation/user/current/execution/tagged_execution.html should take us to the relevant page in the new documentation. It takes us to the main page in the new documentation.

getgauge.io/documentation/user/0.0.5/execution/tagged_execution.html is also taking us to the main page of the new documentation and not the relevant page.

GAUGE_PREFIX=my/custom/path install.sh

This usage has to be documented

When listing gauge usage from the cli we add the following link at the end

Complete documentation is available at https://docs.getgauge.io/.

However this lists the whole documentation and is a getting started guide.

Instead, use https://github.com/rtomayko/ronn to create a man page like listing for e.g. https://rtomayko.github.io/ronn/ronn.1.html of all the commands with examples for easy reading or printing.

As a plus bundle man pages for the cli so that shells like fish can auto complete and display in-line help.
Point documentation link on the cli to something like manual.getgauge.io and link to the main documentation from there.

Gain SEO points.

From @mahendrakariya on June 23, 2016 13:46

On the table params page http://getgauge.io/documentation/user/current/gauge_terminologies/parameters/table_parameters.html

• At the top of the page, we start with Table Parameters can be used in two ways. Bullet should be removed from this line.
• On this page, it's very difficult to find how a user can pass table as a param to step. I think someone new to Gauge will struggle a lot figuring this out. We should add more details about it.
• Data driven execution should be mentioned at the end since it's a slightly advanced topic. The docs on this page should start with table param that can be passed to step.
• There are no docs which says data table at spec level can also be passed from external sources. Should Data table driven scenarios be explained under Param section or Execution section?

I also have a question. Will it be correct to call the table at the top of the spec as a param? We are not passing it as an arg to the step implementation. Personally, I feel it is not a param.

Copied from original issue: getgauge/documentation#53

Docs for current version are 0.9.9 but title says 0.9.8

From @uzmar on September 9, 2015 4:39

there should be explanation for test explore structure and filters(class, traits,project etc.)

Copied from original issue: getgauge/documentation#18

This what Zabil said we should expect:

A new user

• Lands on Gauge.org
• Reads about features
• Clicks “Get Started” button ti view “Get Started” page
• Reads steps to install the Gauge binary, language runner, run tests
• Downloads and installs Gauge if interested
• Sees our support for VS Code
• Reads instructions on how to install Gauge Visual Studio Plugin
  • Reads our welcome page inside VS code (this links to main documentation site) (exit) or
• Clicks on a "Learn More" on the "Getting started" page. (display this at the end of the steps)
• Views main documentation
• Reads installation for other options or to troubleshoot existing installation using the “Installation” section.
• Reads “Write Specifications”
• In each category of documentation we'll add a "What next?" and link to next steps for e.g on "Write Specifications" What next will be "Run Specifications"
• Reads "Run Specifications"

The "Get Started" link is always available on the top menu for those who land directly on the documentation page._

But I don't see the "what's next?" links

From @tigerlei010 on February 9, 2017 13:24

gauge-ruby (0.3.1)

In one step define, copy the following lines from the manual:
// Adding value
scenario_store = DataStoreFactory.scenario_datastore;
scenario_store.put("element-id", "455678");

exec gauge specs/ , error occus:
Specification: specs/example.spec:19
Error Message: uninitialized constant DataStoreFactory
Stacktrace:
/home/tigerlei/work/test/step_implementations/step_implementation.rb:7:in block in <top (required)>' /home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/executor.rb:38:in execute_step'
/home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/processors/execute_step_request_processor.rb:30:in process_execute_step_request' /home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/message_processor.rb:52:in call'
/home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/message_processor.rb:52:in process_message' /home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/gauge_runtime.rb:53:in handle_message'
/home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/gauge_runtime.rb:37:in dispatch_messages' /home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/gauge_runtime.rb:76:in module:Runtime'
/home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/gauge_runtime.rb:29:in <module:Gauge>' /home/tigerlei/.gem/ruby/2.3.0/gems/gauge-ruby-0.3.1/lib/gauge_runtime.rb:27:in <top (required)>'
/usr/local/ruby23/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:133:in require' /usr/local/ruby23/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:133:in rescue in require'
/usr/local/ruby23/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:40:in `require'

Copied from original issue: getgauge/gauge-ruby#36

When BeforeSpec is run for a specific spec file, it is running all the BeforeSpecs in c#
eg: I have 2 spec files (a.spec and b.spec), and have 2 different beforespec implementations (a.cs and b.cs).
EveryTime I run a spec it is running beforeSpec of all spec files.

How to avoid this ?

From @sriv on May 31, 2016 4:25

Document maven target to only run gauge specs

• Use of profile defined in pom.xml
• Passing parameters/properties either via -D flag or define in pom.xml

Copied from original issue: getgauge/documentation#47

From @sriv on May 31, 2016 4:27

• Add info about order of execution of multiple hooks at same level, i.e. if multiple BeforeSpec hooks are defined, what order are they executed.
• Add above info when filtering by tags

Copied from original issue: getgauge/documentation#48

Modify the documentation to add note about telemetry options in the installation section.

The travis instructions currently don't show valid yml. The following section:

      - sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net
          --recv-keys 023EDB0B - echo deb https://dl.bintray.com/gauge/gauge-deb
          stable main \| sudo tee -a /etc/apt/sources.list

Is missing a new line before the echo command.

User should be able to find documentation on how to customize html-report

Issue related to getgauge/html-report#171

From @mahendrakariya on June 9, 2016 11:11

The delimiter for multiple spec files in run config has been changed from , to || due to getgauge/Intellij-Plugin#101. This should be updated in the docs.

We also need to mention that this is a breaking change. Until v0.1.0 of IntelliJ plugin, the delimiter is ,. Any higher version will have delimiter ||.

Copied from original issue: getgauge/documentation#51

From @sguptatw on April 11, 2016 10:29

https://github.com/getgauge/documentation/blob/master/technical/set-up/plugins.md
Technical details of maven and gradle plugins to be added.

Copied from original issue: getgauge/documentation#41

I was going through the available documentation on how to implement step tables in Gauge but there is very limited documentation available and it just talks about how one can call tables in step implementation but it'll be nice to elaborate the example and demonstrate the implementation of a sample table.

Also, I don't see the list of methods applicable to the table object. It'll be nice to add the same. However, the workaround is to use table.rows.methods to get the list of methods.

From @kaustavdm on April 28, 2016 11:11

Adding a documentation on Gauge's execution life-cycle can help users to understand the entire flow of a Gauge execution and take informed decision on when to use which features.

Copied from original issue: getgauge/documentation#45

From @uzmar on September 3, 2015 10:54

Copied from original issue: getgauge/documentation#9

From @RPrimrose on January 6, 2017 15:51

I noticed a couple of broken links to the "Execution Hooks" section.

http://getgauge.io/documentation/user/current/advanced_readings/execution_hooks/context.html and http://getgauge.io/documentation/user/current/advanced_readings/execution_hooks/filtering.html each have a "hooks" link that goes to http://getgauge.io/documentation/user/language_features/execution_hooks.md, which 404's.

Presumably they should point to http://getgauge.io/documentation/user/current/language_features/execution_hooks.html instead.

Copied from original issue: getgauge/documentation#75

Expected behavior
Implementation examples should be available for all languages officially supported.

Actual behavior
Has examples only in Java, C# and ruby

From @kaustavdm on July 11, 2016 9:8

Currently, details on environment variables (configuration options) for Gauge core and runners are spread across 2 different sections, without any internal linking. Also, they are incomplete.

Proposal:

• Merge "Language Features > Configuration" into "Advanced Readings > Gauge Configuration".
• Rename: "Advanced Readings > Gauge Configuration" to "Advanced Readings > Configuration"
• Add language specific configuration options as sub-articles to "Advanced Readings > Configuration".

Copied from original issue: getgauge/documentation#61

From @sguptatw on April 11, 2016 10:25

https://github.com/getgauge/documentation/blob/master/technical/set-up/plugins.md
The technical support speaks only about IDE integration of plugin IntelliJ with gauge.

The other supported IDEs should have similar details listed

Copied from original issue: getgauge/documentation#40

From @sguptatw on May 4, 2016 10:32

It has the old screen shot with Gauge VS2013. This needs to be updated with the latest search parameter "GetGauge"

Copied from original issue: getgauge/documentation#46

Concepts section can have a small example on how a concept is defined and used.

There is no link to go to the home page currently.

The top left gauge image can be a link to the getgauge.io