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

feat: Update the structure of new Coverage engine release note DOCS-623 #1970

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Dec 5, 2023

Updates the new Coverage engine release note to give users more visibility on the updates to different features, which will happen over some months.

👀 Live preview

@nicklem nicklem self-assigned this Dec 5, 2023
Copy link
Contributor

github-actions bot commented Dec 5, 2023

Overall readability score: 54.32 (🔴 -0.01)

File Readability
cloud-2023-11-23-new-coverage-engine-status-checks.md 60.9 (🔴 -1.12)
index.md 75.75 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
cloud-2023-11-23-new-coverage-engine-status-checks.md 60.9 50.87 10.47 12.7 11.37 6.77
  🔴 -1.12 🔴 -1.52 🔴 -0.35 🔴 -0.9 🟢 +0.12 🟢 +0.27
index.md 75.75 96.72 8.78 12.6 9.51 6.27
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.32 43.22 10.86 12.36 12.52 7.86
  🔴 -0.01 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +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

@github-actions github-actions bot temporarily deployed to Netlify December 5, 2023 11:44 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from 72568b5 to 8dfdf6a Compare December 5, 2023 11:48
@github-actions github-actions bot temporarily deployed to Netlify December 5, 2023 11:49 Inactive
@nicklem nicklem marked this pull request as ready for review December 5, 2023 11:54
@nicklem nicklem requested a review from a team as a code owner December 5, 2023 11:54
@nicklem nicklem requested review from a team, machadoit and claudiacarpinteiro December 5, 2023 11:54
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro left a comment

Choose a reason for hiding this comment

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

@nicklem This restructuring looks very good! 👍
I left some comments for your evaluation.

@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 13:14 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from 30529d1 to 4381694 Compare December 6, 2023 13:18
@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 13:19 Inactive
Co-authored-by: Cláudia Carpinteiro <[email protected]>
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from 4381694 to 46890b7 Compare December 6, 2023 13:40
@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 13:42 Inactive
Co-authored-by: Cláudia Carpinteiro <[email protected]>
@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 15:23 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from e6cee10 to c9b1d3a Compare December 6, 2023 15:23
@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 15:25 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from 1c262ad to d42fa15 Compare December 7, 2023 12:49
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 12:51 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from d42fa15 to 75033b8 Compare December 7, 2023 13:08
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 13:09 Inactive
Copy link
Member

@machadoit machadoit left a comment

Choose a reason for hiding this comment

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

LGTM! (we still doing some QA on it, will let you know)

@nicklem nicklem added the don't merge Don't merge this pull request yet label Dec 7, 2023
@machadoit
Copy link
Member

Actually @nicklem can we add a nudge to review the permissions on GitHub like we added on the UI?
image

Maybe in general, and then on the notes of status / summary we state that it needs to be updated?

@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 14:48 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 14:54 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 15:10 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 15:24 Inactive
@nicklem nicklem force-pushed the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch from f12319e to 861c659 Compare December 7, 2023 15:25
@nicklem nicklem enabled auto-merge (squash) December 7, 2023 15:25
Copy link
Member

@machadoit machadoit left a comment

Choose a reason for hiding this comment

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

🚢

@nicklem nicklem removed the don't merge Don't merge this pull request yet label Dec 7, 2023
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 15:26 Inactive
@nicklem nicklem merged commit a006866 into master Dec 7, 2023
@nicklem nicklem deleted the DOCS-623-update-the-structure-of-new-coverage-engine-release-note branch December 7, 2023 15:49
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.

3 participants