citrusframework / citrus-website Goto Github PK

This is missing from the documentation. Refer to the implementation details and generate the documentation based on this.

Moved from citrusframework/citrus#452

Citrus Version Tested with 2.7.6 and 2.8.0-SNAPSHOT

According to the official documentation the Citrus-Maven-Plugin should have 4 goals.

The actual implementation of the plugin has not only more goals, but some of the goals mentioned in the documentation are (not long) part of the plugin.

[INFO] citrus-maven-plugin 2.7.6
  Citrus Maven Plugin

This plugin has 5 goals:

citrus:create-docs
  Creates test documentation in interactive mode. Either uses mode excel for MS
  Excel output or html for HTML web page output.

citrus:create-test
  Creates new Citrus test cases with empty XML test file and executable Java
  class. Mojo offers an interactive mode, where the plugin prompts for
  parameters during execution.

citrus:generate-docs
  Generates test overview documentation based on plugin configuration. Html
  documentation creates a web page that contains a list of all available tests
  with meta information. Excel documentation creates a table of all available
  tests with meta information such as name, author, status and so on.

citrus:generate-tests

citrus:help
  Display help information on citrus-maven-plugin.
  Call mvn citrus:help -Ddetail=true -Dgoal=<goal-name> to display parameter
  details.

I am not sure whether or not this is the right place for this issue, since there is also a repository for the citrus website. Please move the issue if you think it should be located elsewhere.

Citrus Version
3.2.1

Expected behavior
Proper links to the reporting template examples on the Citrus Framework Github

Actual behavior
The links to the template examples lead to 404-page not found errors on your github

Test case sample
First test case:
Click on the "report-templates resources"-link here https://citrusframework.org/citrus/reference/3.2.1/html/index.html#html-reports
this leads to to this page, which doesn't exist:
https://github.com/citrusframework/citrus/tree/master/modules/citrus-core/src/main/resources/com/consol/citrus/report

Second test case:
Go to this page: https://citrusframework.org/samples/reporting/
Click on the link "resources/citrus-application.properties." halfway down the page.
This leads to this page, which also doesn't exist:
https://citrusframework.org/samples/reporting/src/test/resources/citrus-application.properties

Third test case:
Go to this page: https://citrusframework.org/samples/reporting/
Click on the link that says "this sample’s github repository",
this leads to this page:
https://citrusframework.org/samples/reporting/src/test/java/com/consol/citrus/samples/todolist/reporting/ExtentReporter.java
And that too does not exist.

The website currently holds the old contribution guidelines. They are available on https://citrusframework.org/docs/contributing/.
We've just merged the new contribution guidelines into the citrus master https://github.com/citrusframework/citrus/blob/master/CONTRIBUTING.md.

The website should link the new contribution guidelines and the old one should be removed

Citrus Version
citrusframework.org linking issue

Question
There is an issue with linking PDF files from within the main site. I'm getting back a 404 when clicking on the link mentioned below.

What I've tried so far
N/A

Additional information
Link to PDF reference not working:
http://citrusframework.org/reference/pdf/citrus-reference-2.7.8.pdf

https://citrusframework.org/yaks/reference/html/index.html

The link 'Java API' links to http://citrusframework.org/apidocs/index.html which is a 404.

In several parts of the documentation, TestRunner is used where TestActionRunner should be used, e.g. here, here and here.

The String TestRunner is not found once in a source file in citrus-samples.