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: Reorganization of data source how-to files #960

Closed
wants to merge 5 commits into from

Conversation

josmperez
Copy link
Contributor

@josmperez josmperez commented Jun 14, 2024

Complete 3rd stage of the plugin-tools site reorganization project. Move/rename site, fix broken links.

Instructions for testing redirects: docusaurus/website/README.md#Redirects

Fixes: #925

Testing: Refer to design doc

@josmperez josmperez added the no-changelog Don't include in changelog and version calculations label Jun 14, 2024
@josmperez josmperez self-assigned this Jun 14, 2024
@josmperez josmperez requested a review from a team as a code owner June 14, 2024 19:17
@josmperez josmperez requested review from Ukochka and removed request for a team June 14, 2024 19:17
Copy link

github-actions bot commented Jun 14, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@CLAassistant
Copy link

CLAassistant commented Jun 15, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ josmperez
❌ sympatheticmoose
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

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

Prettier modified too many files that shouldn't be part of this PR. I reverted the Prettier cvommit, but many files are still modified. Please remove the modifications. [edited owing to accidental overwriting]


### Backend plugins

- **Add support for alerting** - Backend plugins have inherent support for [Grafana Alerting](https://grafana.com/docs/grafana/latest/alerting/) but this support needs to be enabled. Simply add `"alerting": true` to your `plugin.json` file.
- **Use the `CallResourceHandler` interface to serve custom HTTP requests**. For more information, refer to [Resource handlers](../../key-concepts/backend-plugins/#resources). This is useful, for example, when providing query builders, as shown in this [example](https://github.com/grafana/grafana-plugin-examples/blob/0532f8b23645251997088ac7a1707a72d3fd9248/examples/app-with-backend/pkg/plugin/app.go#L35).
- **Add logs, metrics and traces to your data source.** Make it easier to diagnose and resolve issues for both plugin developers and Grafana operators. Find more information in our [documentation](/create-a-plugin/extend-a-plugin/add-logs-metrics-traces-for-backend-plugins).
- **Add logs, metrics and traces to your data source.** Make it easier to diagnose and resolve issues for both plugin developers and Grafana operators. Find more information in our [documentation](../../how-to-guides/data-source-plugins/add-logs-metrics-traces).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think if we're removing backend-plugins from the name/link, then we need to update the page to make it clear that a backend is required

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i don't follow this suggestion. On the page docusaurus/docs/how-to-guides/data-source-plugins/add-logs-metrics-traces-for-backend-plugins.md, it is clearly marked as related to backend plugins. For example, the opening senence starts "Adding logs, metrics and traces for backend plugins..."

Copy link
Contributor

Choose a reason for hiding this comment

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

please revert

Copy link
Contributor

Choose a reason for hiding this comment

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

please revert

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should be fixed in #976

Copy link
Contributor

Choose a reason for hiding this comment

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

please remove from this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should be fixed in #976

@josmperez
Copy link
Contributor Author

Closing this PR in favor of #976

@josmperez josmperez closed this Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations
Projects
Development

Successfully merging this pull request may close these issues.

Reorganize plugin-tools site based on new design plan
3 participants