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.

Sign up for GitHub

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

Jump to bottom

Edit data dource and panel READMEs #230

Merged
merged 3 commits into from
Jan 8, 2024
Merged

Edit data dource and panel READMEs #230

merged 3 commits into from
Jan 8, 2024

Conversation

josmperez
Copy link
Contributor

Edit several READMEs for Grafana style and readability. This PR will be followed by additional PRs to enhance the examples docs.

@josmperez josmperez added the documentation Improvements or additions to documentation label Dec 6, 2023
@josmperez josmperez self-assigned this Dec 6, 2023
xnyo
xnyo reviewed Dec 13, 2023
View reviewed changes
Copy link
Member

@xnyo xnyo left a comment

Choose a reason for hiding this comment

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

Awesome work! Some minor comments:

examples/datasource-streaming-backend-websocket/README.md Outdated Show resolved Hide resolved
examples/datasource-basic/README.md Outdated Show resolved Hide resolved
@josmperez josmperez requested review from a team as code owners December 26, 2023 21:57
@josmperez josmperez requested review from andresmgot and xnyo and removed request for a team December 26, 2023 21:57
xnyo
xnyo approved these changes Jan 2, 2024
View reviewed changes
Copy link
Member

@xnyo xnyo left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

academo
academo approved these changes Jan 2, 2024
View reviewed changes
Copy link
Member

@academo academo left a comment

Choose a reason for hiding this comment

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

All looks correct. But as mentioned in a similar PR. we are not using yarn for any of our examples. It'd be great to replace all calls to yarn with npm run.

e.g yarn dev should be npm run dev except for install which should remain simply npm install

sympatheticmoose
sympatheticmoose approved these changes Jan 8, 2024
View reviewed changes
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.

changes look good to me 👍 agree with esteban that we should update from Yarn but could be done in separate PR by anyone

examples/datasource-http-backend/README.md Outdated Show resolved Hide resolved
@josmperez josmperez merged commit 7aa2b79 into main Jan 8, 2024
24 checks passed
@josmperez josmperez deleted the josmperez-edit3 branch January 8, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sympatheticmoose sympatheticmoose sympatheticmoose approved these changes

@xnyo xnyo xnyo approved these changes

@academo academo academo approved these changes

@oshirohugo oshirohugo Awaiting requested review from oshirohugo

@andresmgot andresmgot Awaiting requested review from andresmgot andresmgot is a code owner automatically assigned from grafana/plugins-platform-backend

Assignees

@josmperez josmperez

Labels
documentation Improvements or additions to documentation
Projects
Plugins Platform / Grafana Community
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@josmperez @academo @xnyo @sympatheticmoose