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

Fix erroneous documentation #353

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Conversation

jdbaldry
Copy link
Member

This section confused the behavior of the docs/reference shortcode and the generic Markdown reference-style link syntax.

Signed-off-by: Jack Baldry [email protected]

This section confused the behavior of the `docs/reference` shortcode and the generic Markdown reference-style link syntax.

Signed-off-by: Jack Baldry <[email protected]>
@github-actions
Copy link
Contributor

Overall readability score: 60.13 (🔴 -0.01)

File Readability
index.md 63.76 (🔴 -0.23)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 63.76 46.88 8.94 11.9 12.24 6.47
  🔴 -0.23 🟢 +0 🟢 +0 🔴 -0.1 🔴 -0.06 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.13 47.05 9.65 11.77 12.14 7.33
  🔴 -0.01 🟢 +0 🟢 +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

{{%/* docs/reference */%}}
[Grafana website]: "/ -> www.grafana.com"
{{%/* /docs/reference */%}}
[Grafana website]: www.grafana.com
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this still contained within the docs/reference shortcode, or outside?

@clayton-cornell clayton-cornell added the type/docs Docs Squad label used across all Grafana Labs repos label Oct 20, 2023
@jdbaldry jdbaldry merged commit 3905268 into main Oct 23, 2023
6 checks passed
@jdbaldry jdbaldry deleted the jdb/2023-10-fix-docs-reference branch October 23, 2023 06:35
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