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 content and screenshots #3986

Merged

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented Aug 21, 2024

What this PR does:

Updates the content for the query editor:

  • Deletes outdated screenshots
  • Updates most of the screenshots of the query editor used in the Tempo docs (screenshots stored in the cloud drive)
  • Remove the content for how to use the Tempo data source in Grafana; instead link to those pages
  • Delete the query builder and query editor pages (replaced with overview page that links to Grafana docs)
  • Update screenshots used on the metrics-generator page
  • Update screenshots used on the service graph page

Related PR: grafana/grafana#91910

Which issue(s) this PR fixes:
Fixes https://github.com/grafana/tempo-squad/issues/339

Related: https://github.com/grafana/tempo-squad/issues/266

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Aug 21, 2024
@knylander-grafana knylander-grafana self-assigned this Aug 21, 2024
@knylander-grafana
Copy link
Contributor Author

@jdbaldry I know we've done this before, but I am not finding how to do this... How do I update the doc-validator version? It's erroring saying I need to use relrefs...

@jdbaldry
Copy link
Member

@jdbaldry I know we've done this before, but I am not finding how to do this... How do I update the doc-validator version? It's erroring saying I need to use relrefs...

I think this could be considered a bug. The latest version of doc-validator also will insist on using relref instead of relative URLs that start ./ or ../. You can eliminate the errors now by using full URLs and version substitution or I can make a code change tomorrow and release a new version.

@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Aug 21, 2024

I think this could be considered a bug. The latest version of doc-validator also will insist on using relref instead of relative URLs that start ./ or ../. You can eliminate the errors now by using full URLs and version substitution or I can make a code change tomorrow and release a new version.

Can we use relative links within the same project or will that cause an error as well? -- Ah it will cause the same relref error. You answered that quesion.

@knylander-grafana
Copy link
Contributor Author

The Aliases are fixed and working as expected.

Copy link
Contributor

This PR must be merged before a backport PR will be created.

Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Thanks for taking a stab at the aliases!

We should store media assets in https://grafana.com/docs/writers-toolkit/write/image-guidelines/#where-to-store-media-assets to avoid bloating this repository and the website repository with binary files

Copy link
Contributor

@zalegrala zalegrala left a comment

Choose a reason for hiding this comment

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

Nice work. Looks good to me.

@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Aug 27, 2024

Thanks for taking a stab at the aliases!

We should store media assets in grafana.com/docs/writers-toolkit/write/image-guidelines#where-to-store-media-assets to avoid bloating this repository and the website repository with binary files

I have a doc issue to change the location of all images (#3848). When ever I do doc updates, I'm trying to move the images as I can. All new screenshots were uploaded to the cloud storage.

Some of the screenshots in this section, especially the APM screens, were used in blog posts. Any file that's removed has to be checked in the website to make sure it won't suddenly make a screenshot disappear. I did that for the files I removed. I just ran out of time to do the rest.

@knylander-grafana knylander-grafana merged commit 7ee2119 into grafana:main Aug 28, 2024
17 checks passed
@knylander-grafana knylander-grafana deleted the updates-for-query-editor-11-2 branch August 28, 2024 15:32
github-actions bot pushed a commit that referenced this pull request Aug 28, 2024
Co-authored-by: Jack Baldry <[email protected]>
(cherry picked from commit 7ee2119)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.6 type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants