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: Improve guidance around authentication/OAuth [UXR] #1227

Open
josmperez opened this issue Oct 17, 2024 · 1 comment
Open

Docs: Improve guidance around authentication/OAuth [UXR] #1227

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

Comments

@josmperez
Copy link
Contributor

Incorporate feedback such as this:

  • Better explain how to use routes in authentication.
  • Better explain OAuth flow.
  • Add an example of OAuth with a backend API to show how to store secrets, and how to refresh an OAuth token when it expires.
  • How to figure out which fields are secrets.

Note that we don't want to repeat OAuth documentation.

@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
@andresmgot
Copy link
Contributor

Some thoughts:

  • Better explain how to use routes in authentication.

FWIW, using "routes" and the plugin proxy in general is not something we want to promote, more like a legacy feature we don't plan to keep working on.

  • Better explain OAuth flow.

The current documentation that we have for this:

  • Add an example of OAuth with a backend API to show how to store secrets, and how to refresh an OAuth token when it expires.

I don't think this is something managed by plugins. You can refer to the general auth docs from Grafana.

  • How to figure out which fields are secrets.

I also think this is just generic auth knowledge? Nothing related to plugins.

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

2 participants