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 product name guidance #357

Merged
merged 6 commits into from
Oct 24, 2023
Merged

Conversation

imatwawana
Copy link
Contributor

This PR adds guidance regarding who you should ask for about whether something is a product or not.

@imatwawana imatwawana added the type/docs Docs Squad label used across all Grafana Labs repos label Oct 23, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2023

Overall readability score: 60.2 (🟢 +0.03)

File Readability
index.md 59.14 (🟢 +1.62)
index.md 74.38 (🔴 -0.33)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 59.14 50.63 10.28 10.3 11.99 8.22
  🟢 +1.62 🟢 +7.95 🟢 +0.08 🟢 +0 🟢 +0.05 🟢 +0.03
index.md 74.38 58.28 7.77 9.4 10.43 6.3
  🔴 -0.33 🔴 -0.2 🔴 -0.07 🔴 -0.1 🟢 +0 🔴 -0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.2 47.24 9.64 11.77 12.13 7.33
  🟢 +0.03 🟢 +0.18 🟢 +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

imatwawana and others added 2 commits October 23, 2023 16:33
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

LGTM

@imatwawana imatwawana merged commit f57cf8e into main Oct 24, 2023
@imatwawana imatwawana deleted the ihm/231023-product-name-guidance branch October 24, 2023 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants