Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dast documentation [TAROT-3247] #2371

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

joanasteodoro
Copy link
Contributor

@joanasteodoro joanasteodoro commented Apr 4, 2025

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

Copy link
Contributor

github-actions bot commented Apr 4, 2025

Overall readability score: 53.32 (🟢 +0.07)

File Readability
managing-security-and-risk.md 52.85 (🟢 +0.77)
running-dast-scans.md 68.39 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
managing-security-and-risk.md 52.85 34.36 10.74 14.3 13.46 6.64
  🟢 +0.77 🔴 -0.4 🔴 -0.05 🟢 +0.1 🟢 +0.46 🟢 +0.04
running-dast-scans.md 68.39 49.31 8.61 9.5 10.66 7.11
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.32 42.79 10.86 12.63 12.68 7.96
  🟢 +0.07 🟢 +0.03 🟢 +0.01 🟢 +0.01 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch 3 times, most recently from 028b237 to 43cf9f5 Compare April 7, 2025 11:20
@github-actions github-actions bot temporarily deployed to Netlify April 7, 2025 11:21 Inactive
@joanasteodoro joanasteodoro requested a review from a team April 7, 2025 11:24
@joanasteodoro joanasteodoro marked this pull request as ready for review April 7, 2025 11:24
@joanasteodoro joanasteodoro requested a review from a team as a code owner April 7, 2025 11:24
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch 2 times, most recently from 8f41513 to 365dff8 Compare April 7, 2025 15:10
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch from 365dff8 to 3ee5ea9 Compare April 7, 2025 15:13
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch from 3ee5ea9 to e197523 Compare April 7, 2025 15:22
@github-actions github-actions bot temporarily deployed to Netlify April 7, 2025 15:23 Inactive
## Examples to Run scans on Deployment

!!! note
The examples below trigger scans on deployment which may analyze, not the latest, but the previous version of the application. To run DAST post deployment you may explore options such as:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was trying to give options to users here, but honestly I don't really know what to suggest...

Ideally, the examples we had below would work post deploy (the one from circleci seems to work for example), but that doesn't seem the case. @lventura-codacy @afsmeira @lorandszakacs could any of your gentle souls take a look at these examples and review / improve them? 😭 thank u guys

@github-actions github-actions bot temporarily deployed to Netlify April 7, 2025 16:16 Inactive
@claudiacodacy claudiacodacy requested review from lventura-codacy and removed request for claudiacodacy April 8, 2025 08:19
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch 3 times, most recently from 3c51988 to 386e81f Compare April 8, 2025 10:18
@github-actions github-actions bot temporarily deployed to Netlify April 8, 2025 10:19 Inactive
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch from 386e81f to ec7ca0b Compare April 8, 2025 10:25
@github-actions github-actions bot temporarily deployed to Netlify April 8, 2025 10:27 Inactive
@joanasteodoro joanasteodoro force-pushed the add-dast-documentation-tarot-3247 branch from ec7ca0b to 55858f2 Compare April 8, 2025 10:42
@github-actions github-actions bot temporarily deployed to Netlify April 8, 2025 10:43 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants