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

delete old coverage files and add new page for new coverage page [CY-7340] #2202

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

Conversation

joanasteodoro
Copy link

@joanasteodoro joanasteodoro commented Sep 16, 2024

👀 Live preview

https://update-docs-with-new-coverage-page--docs-codacy.netlify.app/repositories/coverage/

Important note:
I had to delete links where the old coverage pages were referenced for the build to run successfully.

🚧 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

Remember to add redirects

This PR deletes one or more md files:
docs/repositories-coverage/commits.md
docs/repositories-coverage/files.md
docs/repositories-coverage/pull-requests.md
docs/repositories-coverage/repository-dashboard.md

Remember to append the appropriate redirects in mkdocs.yml under plugins.redirects.redirect_maps.

Copy link
Contributor

github-actions bot commented Sep 16, 2024

Overall readability score: 53.83 (🔴 -0.1)

File Readability
integrating-codacy-with-intellij-ides.md 65.94 (🔴 -0.39)
integrating-codacy-with-visual-studio-code.md 67.15 (🔴 -0.7)
cloud-2023-11-23-new-coverage-engine-status-checks.md 56 (🟢 +0)
cloud-2024-02.md 48.13 (🟢 +0)
commits.md 51.22 (🟢 +0)
coverage.md 68.42 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
integrating-codacy-with-intellij-ides.md 65.94 52.49 10.59 10.8 9.98 6.69
  🔴 -0.39 🟢 +0 🔴 -0.02 🔴 -0.1 🔴 -0.06 🔴 -0.04
integrating-codacy-with-visual-studio-code.md 67.15 52.6 10.11 11 10.15 6.41
  🔴 -0.7 🟢 +0 🔴 -0.09 🔴 -0.2 🔴 -0.11 🔴 -0.03
cloud-2023-11-23-new-coverage-engine-status-checks.md 56 48.03 11.55 14.1 11.73 6.78
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
cloud-2024-02.md 48.13 31.78 10.25 13.6 14.61 8.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
commits.md 51.22 33.65 11.05 15.4 13 6.65
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
coverage.md 68.42 48.5 8.4 10.4 11.65 6.33
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.83 42.88 10.82 12.48 12.59 7.93
  🔴 -0.1 🔴 -0.08 🔴 -0.01 🟢 +0.01 🔴 -0.01 🔴 -0.02
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 update-docs-with-new-coverage-page-cy-7340 branch from 3535b0f to 8fba5b5 Compare September 16, 2024 17:02
@github-actions github-actions bot temporarily deployed to Netlify September 16, 2024 17:12 Inactive
@joanasteodoro joanasteodoro changed the title delete old coverage files and add new page for new coverage page cy-7340 delete old coverage files and add new page for new coverage page [CY-7340] Sep 16, 2024
@github-actions github-actions bot temporarily deployed to Netlify September 16, 2024 17:20 Inactive
@joanasteodoro joanasteodoro marked this pull request as ready for review September 16, 2024 17:21
@joanasteodoro joanasteodoro requested a review from a team as a code owner September 16, 2024 17:21
@joanasteodoro joanasteodoro requested review from alerizzo and a team September 16, 2024 17:21
@joanasteodoro joanasteodoro force-pushed the update-docs-with-new-coverage-page-cy-7340 branch from ca819ed to 6a74f75 Compare September 17, 2024 11:09
@github-actions github-actions bot temporarily deployed to Netlify September 17, 2024 11:10 Inactive
Copy link
Contributor

@afsmeira afsmeira left a comment

Choose a reason for hiding this comment

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

LGTM.

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