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

[DOC] Update query-editor.md #2452

Merged
merged 1 commit into from
May 23, 2023

Conversation

knylander-grafana
Copy link
Contributor

What this PR does:
Preparing to share the content from the query editor page to the Cloud and the Grafana docs. This update:

  • Changes the image calls from the TraceQL query editor page to use the asset storage in GCP instead of local storage
  • Removes calls to specific Tempo versions
  • Adds a few words about Grafana Cloud vs Grafana

@knylander-grafana
Copy link
Contributor Author

@jdbaldry This is the information on the query editor that we talked about sharing to Grafana and Grafana Cloud docs.

@jdbaldry
Copy link
Member

jdbaldry commented May 11, 2023

Nice, do we know at which URL paths we want to see this content?

We could use Hugo mounts for this, or our docs/shared shortcode.

The former has the downside that we need to make sure we remember that this content is reused in multiple places. Perhaps we can annotate the file with some information in the front matter?

@knylander-grafana
Copy link
Contributor Author

@jdbaldry this content will probably need to be in Grafana Cloud in the Traces data sources section and in Grafana in the Tempo query section. We might be able to just share the file to those other areas.

@jdbaldry
Copy link
Member

So that would be /docs/grafana-cloud/data-configuration/traces/query-editor/ and docs/grafana/latest/datasources/tempo/query-editor/?
I noticed that the latter already exists (https://grafana.com/docs/grafana/latest/datasources/tempo/query-editor/), are we replacing it?

@knylander-grafana
Copy link
Contributor Author

So that would be /docs/grafana-cloud/data-configuration/traces/query-editor/ and

Yes.

docs/grafana/latest/datasources/tempo/query-editor/? I noticed that the latter already exists (https://grafana.com/docs/grafana/latest/datasources/tempo/query-editor/), are we replacing it?

@jdbaldry For now, I wouldn't replace the existing query-editor page. I am adding other content for the query editor that will be added to that page in datasources/tempo/query-editor.

@knylander-grafana knylander-grafana merged commit e8b943c into main May 23, 2023
16 of 17 checks passed
@knylander-grafana knylander-grafana deleted the Query-editor-updates-for-sharing branch May 23, 2023 01:49
github-actions bot pushed a commit that referenced this pull request May 23, 2023
(cherry picked from commit e8b943c)
knylander-grafana added a commit that referenced this pull request May 24, 2023
(cherry picked from commit e8b943c)

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.1 type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants