codacy / docs

Codacy documentation
https://docs.codacy.com
Other
21 stars 38 forks source link

[DOCS-386] Add extra context before coverage setup instructions #1268

Closed prcr closed 2 years ago

prcr commented 2 years ago

Type of feedback

Feedback

It could be beneficial to have a "Before you start" section on the coverage setup page providing a bit more context to users on how coverage works at Codacy, and which configurations the product expects to correctly present coverage data.

For example, we should make it clearer that we expect the CI/CD workflow of the users to upload coverage data:

Affected pages This feedback applies to the following documentation pages / URLs:

https://docs.codacy.com/coverage-reporter/

Additional context If applicable, provide any other context or information that could be useful in updating the documentation:

Validate with the Support team what are the most common questions that users ask regarding setting up coverage.

github-actions[bot] commented 2 years ago

Internal Jira issue: DOCS-386