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

introduce standard admonitions on docs pages, with links to quickstart #335

Closed
wants to merge 2 commits into from

Conversation

moxious
Copy link

@moxious moxious commented Feb 6, 2025

The CSV plugin, while deprecated, is a big problem in our overall docs because it's got extreme Google SEO juice. Google "Grafana CSV" and you'll land here. In cloud data, we see a substantial number of people try & fail down this route. To that end, we wrote a simple blog post that tells people where to go the right way (use Infinity as we know).

In Grafana web data, we see CSV plugins docs still getting substantial traffic. This PR simply updates the admonition in the docs to point to a clean set of instructions/examples on "how to do CSV right", and then copies the admonition onto the docs pages. The goal is to gradually redirect users away from this approach over time, and towards the infinity approach.

@moxious moxious requested a review from a team as a code owner February 6, 2025 13:01
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Github Action seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@moxious moxious requested a review from gabor February 6, 2025 13:01
yesoreyeram
yesoreyeram previously approved these changes Feb 6, 2025
@moxious moxious added the type/docs Improvements or additions to documentation label Feb 6, 2025
@ivanahuckova
Copy link
Member

@moxious thank you for contribution. I was not able to figure out failing CLA for Github Action here, so I recreated the PR #337. So closing this one in favour of #337.

ivanahuckova added a commit that referenced this pull request Feb 7, 2025
#337)

#335 is stuck on
following issue and I don't know easy way to make gihub action sign cla.
So this was faster - just to recreate the PR.

<img width="961" alt="image"
src="https://github.com/user-attachments/assets/b7f47e89-0996-4ac9-81d1-7dd92d9273bc"
/>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants