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

Use "data source plugin" instead of "data-source plugin" #356

Merged
merged 8 commits into from
Oct 25, 2023

Conversation

jdbaldry
Copy link
Member

  • data source plugin: Consistent with our advice to eliminate "datasource" (one word).
  • data-source plugin: Technically correct as "data source" becomes the adjective.
    Pragmatically, requires a lot of education and changes across all existing documentation and also across the Grafana UI.

In the end, with Eve and Fiona considering all angles, the decision was not to add the hyphen.

Style roundtable discussion: https://docs.google.com/document/d/1uCjtHEy0lpZggkpgsLDjWwxV9K6h7vcsG2dy4TOS6EA/edit#heading=h.kr6qvkov3k9p.

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

- **data source plugin**: Consistent with our advice to eliminate "datasource" (one word).
- **data-source plugin**: Technically correct as "data source" becomes the adjective.
  Pragmatically, requires a lot of education and changes across all existing documentation and also across the Grafana UI.

> In the end, with Eve and Fiona considering all angles, the decision was not to add the hyphen.

Style roundtable discussion: https://docs.google.com/document/d/1uCjtHEy0lpZggkpgsLDjWwxV9K6h7vcsG2dy4TOS6EA/edit#heading=h.kr6qvkov3k9p.

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

github-actions bot commented Oct 23, 2023

Overall readability score: 60.01 (🔴 -0.19)

File Readability
index.md 48.66 (🔴 -7.97)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 48.66 47.32 13.31 14.6 11.49 7.97
  🔴 -7.97 🔴 -1.93 🔴 -1.15 🔴 -1.6 🔴 -1.1 🔴 -0.56

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.01 47.19 9.67 11.81 12.16 7.34
  🔴 -0.19 🔴 -0.04 🔴 -0.03 🔴 -0.04 🔴 -0.03 🔴 -0.01
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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@jdbaldry
Copy link
Member Author

There is a significant drop in the readability indexes for this page but I think for now it is much more important to have the correct information published.

Readability can be iterated on later.

@jdbaldry jdbaldry merged commit 9521053 into main Oct 25, 2023
9 checks passed
@jdbaldry jdbaldry deleted the jdb/2023-10-data-source-plugin branch October 25, 2023 09:28
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