allure-framework/allure-docs

Allure Framework documentation

allure-docs's Issues

https://docs.qameta.io/allure/#_linux

Hi, a suggestion in the documentation, could add the following command for installation:
npm install -g allure-commandline

Because linux users are having problems with the repository.

[Behave] python behave framework

[Reporting] Allure maven plugin is ahead of the latest release

Based on the https://github.com/allure-framework/allure-maven/releases link , I am assuming that the doc should have 2.8 version for allure-maven.

[Features] History

[Tabs] Timeline

[Features] Categories

Add info how to define categories in report.

[Tabs] Overview

Can't adapt my own tool

I can generate the data structure required by allure by myself, but I searched through the documentation and didn't see what kind of data structure it needs?

Update doc - Suite was renamed to xUnit

Suites tab is no longer exists, was renamed to xUnit but published documentation is still referencing it.

https://docs.qameta.io/allure#_suites

[Tabs] xUnit

Missing section and broken link in documentation

Line 9 and 10 of the following file contains a broken link, and makes a reference of a section that doesn't exist in the documentation.
https://github.com/allure-framework/allure-docs/blame/main/content/plugins/existing.md

[Reporting] Refresh Jenkins docs

[Features] Environment

Plugins guide

[FAQ] OOM after adding assertJ

Probable you have a huge classpath. To solve the problem configure weaver to process only classes with steps/attachments.

add META-INF/aop-ajc.xml to classpath with the following content

<aspectj>
 <weaver options="">
  <include within="your.base.package.*" />
 </weaver>
</aspectj>

Update TestNG docs

There were made several outstanding updates in allure-java + 2.0 version has been released. Some docs' parts are outdated.

Unable to locate package allure-commandline

sudo apt-add-repository ppa:qameta/allure
sudo apt-get update
sudo apt-get install allure-commandline

Executing commands from documentation results in

Unable to locate package allure-commandline

Documentation needs update about Bintray dowload ?

Download URL in the documentation points to Bintray, but 2.8.x releases are not published there.

Does the documentation needs an update on this point or is here a reason not to publish 2.8.x on Bintray ? Are you interested by a PR to update the documentation ?

What is the new official way to download Allure (I download maven allure-commandline artifact on my side) ?

[FAQ] Java tests hangs after adding Allure listener

The problem with slow host resolve (dns lags)

allure-framework/allure1@8c935af

https://thoeni.io/post/macos-sierra-java/

Issue Building Dockerfile

Upon cloning your repository I tried to build a docker image using the command

docker build --tag=allure-docs .

and got the following error:

Sending build context to Docker daemon  13.55MB
Step 1/3 : FROM nginx:1.12-alpine
1.12-alpine: Pulling from library/nginx
550fe1bea624: Pull complete
af3988949040: Pull complete
d6642feac728: Pull complete
c20f0a205eaa: Pull complete
Digest: sha256:db5acc22920799fe387a903437eb89387607e5b3f63cf0f4472ac182d7bad644
Status: Downloaded newer image for nginx:1.12-alpine
 ---> 24ed1c575f81
Step 2/3 : COPY build/docs/html5 /usr/share/nginx/html
COPY failed: stat /var/lib/docker/tmp/docker-builder908779930/build/docs/html5: no such file or directory

[Features] Supported formats

Documentation links not working for Getting Started and Report Structure since server is not running

Pre-check

• [o] I'm aware that I can edit the docs and submit a pull request

Describe the improvement

I'd like to report

• Unclear documentation
• A typo
• Missing documentation
• Other

Description of the improvement / report
A clear and concise description.
On the documentation for allure: https://docs.qameta.io/allure/
the links for Getting started and report structure and features not working since server is not running.

[Tabs] Categories

Update symlink to 2.0

Jenkins Plugin install issue

The section about installing Allure to Jenkins from an archive instructs users to download allure-commandline.zip from Github releases. however, the latest release with that zip is 2.0-BETA1. Should the install instructions point to bintray instead?

Add metrics

• metrica.yandex.ru
• analytics.google.com

Add the asciidoctor task after the build tsk

[Features] Test fixtures

[Tabs] Packages

Typo in Cucumber JVM

[Features] Retries

[FAQ] Required CSP settings to serve the report

default-src 'self';
script-src 'self' 'unsafe-inline' 'unsafe-eval';
style-src 'self' 'unsafe-inline';
font-src 'self' data:;
img-src 'self' data:

URL to demo page results in 404

Hi everyone,

I was just evaluating Allure and wanted to check out the demo. Unfortunately the link to https://qameta.io/allure/demo is not working.

I would fix this myself, but I'm not sure if the link changed or the demo is broken. If you point me in the right direction I can make the change myself.

Thanks for Allure :D

Cheers,
Michael

[Doc][TestNG][v2] Missing allure-testng artefact.

The documentation on Allure2-TestNG integration (https://allure-framework.github.io/allure-docs/2.0/#_testng) advises to use io.qameta.allure.allure-testng as a dependency.
I was not able to get the artefact upon, looks corresponding code is missing in https://github.com/allure-framework/allure2
Expected results: the instruction refers to available artefacts and/or there are steps on how-to get all dependencies (including snapshots).

Update JUnit 5 documentation for simpler configuration

Hello everyone, thanks for the useful framework.

While setting this up with Junit 5, I noticed documentation can be updated, with a slightly simpler configuration:

• By upgrading to maven-surefire-plugin to 2.22.2, one does not need to provided a junit-platform-surefire-provider anymore (it is deprecated on latests version of Junit 5)
• When using the latest version of allure-maven (2.10.0), it is not necessary to provide reportVersion in the configuration
• When using the latest version of allure-maven (2.10.0), it is not necessary to provide junit.jupiter.extensions.autodetection.enabled property.
• In order for the report to be generated via a mvn test allure:report, i had to customize allure.results.directory system property. (it is described somewhere else in the docs)

Below is my current setup

<properties>
    <aspectj.version>1.9.7</aspectj.version>
</properties>

<dependencies>
        <dependency>
            <groupId>io.qameta.allure</groupId>
            <artifactId>allure-junit5</artifactId>
            <version>LATEST_VERSION</version>
            <scope>test</scope>
        </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
                 <version>2.22.2</version>
                <configuration>
                <testFailureIgnore>false</testFailureIgnore>
                        <argLine>
                            -javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
                        </argLine>
                    <systemProperties>
                       <allure.results.directory>${project.build.directory}/allure-results</allure.results.directory>
                    </systemProperties>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.aspectj</groupId>
                        <artifactId>aspectjweaver</artifactId>
                        <version>${aspectj.version}</version>
                    <dependency>
                </dependencies>
            </plugin>
            <plugin>
                <groupId>io.qameta.allure</groupId>
                <artifactId>allure-maven</artifactId>
                <version>LATEST_VERSION</version>
            </plugin>
    </plugins>
</build>
...

I'll gladly make a PR if you find these changes useful.

PS. Documentation seems exposed at two different URLs, what is the difference ?

• https://docs.qameta.io/allure-report/frameworks/java/junit5
• https://docs.qameta.io/allure/#_junit_5

[Features] Muted tests

[TestNG] Latest adaptor updates

Cucumber-JVM Plugin Documentation

Need to write documentation for:

• General usage
• Service tags usage
• Workflow rules (Failed @after doesn`t fail the test in report etc...)
• JUnit integration
• TestNG integration
• Gradle integration
• Maven integration

Documentation website is not accessible

Attempting to access the documentation address (https://docs.qameta.io/allure/) returns: "default backend - 404"

[Features] Flaky tests

[Features] Cucumber JVM section has a spelling mistake

Nee to fix the InputStream spelling

upgrade docs version to 2.3

[Core] Test statuses

[Tabs] Graphs

Decrease leveloffset on one where required

Documentation for allure-js is missing and/or out of date

I'm looking for the docs for allure-js. When I check the website, I see docs for the deprecated mocha-allure-reporter, not for the allure-mocha npm package.

https://docs.qameta.io/allure/#_mocha

Is it possible to get some up-to-date documentation?

Thank you!

[Core] Test stages

Duplicate results reported

Hi there, I'm getting same test cases reported two times in the report. Not sure what is causing this one, any clue would help.