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: query editors by copilot #1145

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

sympatheticmoose
Copy link
Contributor

@sympatheticmoose sympatheticmoose commented Sep 28, 2024

What this PR does / why we need it:

This is an experiment, drafting our documentation using copilot.

Checking out the main grafana repo and using copilot within VS code, the following prompt was given:

you are a technical documentation writer. Given the files in this workspace, search for examples of QueryEditor.

Use this information to generate a how-to tutorial in markdown for creating a query editor for a Grafana data source plugin.

You can assume readers have an understanding of typescript and react.

The tutorial should have the following structure:

Introduction (what a query editor is)
Types of query editor (this should talk about code and builder options)
Creating a code editor (this should describe the steps required to provide a basic monaco code editor as a query editor)
Creating a builder editor (this should describe the steps required to provide a builder editor as a query editor and how to create a selector to allow users to switch between the two)
Summary (what the user has learned)

It was then asked:

@github given [https://grafana.com/docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-rule/](vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-sandbox/workbench/workbench.html) extend the introduction to mention how the query editor is used within Grafana alerting

The results from the second query were slightly edited and our doc metadata was manually added. But everything else is as-is in the first commit to this PR.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Copy link

github-actions bot commented Sep 28, 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.

@sympatheticmoose sympatheticmoose added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Sep 28, 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 type/docs Changes only affect the documentation
Projects
Status: 🧑‍💻 In development
Development

Successfully merging this pull request may close these issues.

1 participant