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

Docs: Add conceptual docs for advanced development topics [UXR] #1236

Open
josmperez opened this issue Oct 17, 2024 · 0 comments
Open

Docs: Add conceptual docs for advanced development topics [UXR] #1236

josmperez opened this issue Oct 17, 2024 · 0 comments
Assignees
Labels
type/docs Changes only affect the documentation

Comments

@josmperez
Copy link
Contributor

josmperez commented Oct 17, 2024

Incorporate feedback such as:

  • Wants more docs for understanding concepts.
  • Doesn’t want more step by step docs because they’re mostly good only for beginners, but they want explanations of more advanced features. They had to rely on source code to understand advanced functions.
  • Examples of advanced topics:
    Wants better docs on annotation support on backend.
    Wants better docs on creating a plugin that can work with alerting, and how data frames can be used with alerting.
    Suggests that we improve doc on using create-plugin because forum posts were outdated on how to use Go to support order of map data type.
    Had to contact support about plugin options. There’s a Getting Started guide, but doesn’t document the option parameters. Should have the code on GitHub, but would be better if there were a documented version of the code.
    Had difficulty with establishing database connector, and used tutorials. Could use more detail in tutorials. Needed to have a mental model of how everything fit together.
    There’s both an HTML input component and a code input component, he didn’t know about both. No info that says that if you want to enter SQL, etc., then use the code component.

Note this issue is a draft that will need to be broken into subtasks or separate issues.

@josmperez josmperez added the type/docs Changes only affect the documentation label Oct 17, 2024
@josmperez josmperez self-assigned this Oct 17, 2024
@tolzhabayev tolzhabayev moved this from 📬 Triage to 💡 Ideation in Plugins Platform / Grafana Community Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Changes only affect the documentation
Projects
Status: 💡 Ideation
Development

No branches or pull requests

1 participant