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 grot guide docs #820

Merged
merged 19 commits into from
Aug 30, 2024
Merged

Add grot guide docs #820

merged 19 commits into from
Aug 30, 2024

Conversation

grafsean
Copy link
Collaborator

Adds grot guide shortcode docs, highlights shortcode params to override default copy.

Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Thank you so much for adding this!

If we do split this into a separate page, I have some conceptual documentation I can contribute about how we track Grot guide usage in https://grafanawebsite.grafana.net/d/adtwukqld20hsb/grot-guides?var-session=.%2B&var-env=master&var-guides=$__all&from=now-1h&to=now&timezone=browser&var-query0=1d&var-pages=$__all&var-range=30d&_dash.hideTimePicker

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 Outdated Show resolved Hide resolved
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 Outdated Show resolved Hide resolved
docs/sources/write/shortcodes/index.md Outdated Show resolved Hide resolved
grafsean and others added 3 commits August 29, 2024 12:16
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
grafsean and others added 2 commits August 29, 2024 12:17
@grafsean
Copy link
Collaborator Author

@jdbaldry how does that look now?

docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
@grafsean grafsean requested a review from jdbaldry August 29, 2024 12:44
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Outdated Show resolved Hide resolved
docs/sources/write/grot-guides/index.md Show resolved Hide resolved
grafsean and others added 3 commits August 29, 2024 14:00
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Beautiful, thanks for sticking with me on this one.

It may be nice to get a technical writer less familiar with Grot guides to take a look, either before we merge this or after, to make sure that it helps the target audience.

One final ask, could you add a row to https://grafana.com/docs/writers-toolkit/whats-new/ (https://github.com/grafana/writers-toolkit/blob/main/docs/sources/whats-new.md?plain=1#L23-L25). For a bigger reference, you can refer to https://developers.google.com/style/whats-new

docs/sources/write/grot-guides/index.md Show resolved Hide resolved
@grafsean grafsean merged commit 4907bef into main Aug 30, 2024
6 checks passed
@grafsean grafsean deleted the grafsean/grot-guide-shortcode-1 branch August 30, 2024 13:35
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.

2 participants