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 collapse shortcode use cases #347

Merged
merged 5 commits into from
Oct 18, 2023

Conversation

imatwawana
Copy link
Contributor

@imatwawana imatwawana commented Oct 10, 2023

Constrains use cases for the collapse shortcode to deprecations and configuration options per the Oct 5 style roundtable meeting. Also adds guidance re lead-in sentences and titles.

@imatwawana imatwawana added the type/docs Docs Squad label used across all Grafana Labs repos label Oct 10, 2023
docs/sources/write/shortcodes/index.md Outdated Show resolved Hide resolved
docs/sources/write/shortcodes/index.md Outdated Show resolved Hide resolved
docs/sources/write/shortcodes/index.md Show resolved Hide resolved
docs/sources/write/shortcodes/index.md Show resolved Hide resolved
@imatwawana imatwawana requested a review from JStickler October 10, 2023 21:25
The following example is for a deprecated store and shouldn't be used for new Loki deployments:

{{</* collapse title="boltdb-shipper" */>}}
Also known as “boltdb-shipper” during development (and is still the schema store name).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Also known as “boltdb-shipper” during development (and is still the schema store name).
Also known as _boltdb-shipper_ during development (and is still the schema store name).

Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Unblocking with feedback

docs/sources/write/shortcodes/index.md Outdated Show resolved Hide resolved
docs/sources/write/shortcodes/index.md Outdated Show resolved Hide resolved
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.

Nice! Thanks for writing this up so clearly.

Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Ursula Kallio <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Oct 17, 2023

Overall readability score: 60.07 (🔴 -0.03)

File Readability
index.md 63.47 (🔴 -1.27)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 63.47 47.18 8.84 12 12.41 6.51
  🔴 -1.27 🔴 -0.2 🔴 -0.24 🔴 -0.3 🔴 -0.12 🔴 -0.07

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.07 46.87 9.65 11.78 12.14 7.34
  🔴 -0.03 🟢 +0 🔴 -0.01 🔴 -0.01 🟢 +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 18, 2023 12:02
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@imatwawana imatwawana merged commit 952a75b into main Oct 18, 2023
5 checks passed
@imatwawana imatwawana deleted the ihm101023/add-collapse-shortcode-guidance branch October 18, 2023 16:05
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.

4 participants