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

Docs: Enhance datasource READMEs #254

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Docs: Enhance datasource READMEs #254

wants to merge 13 commits into from
+150 −26

Conversation

josmperez
Copy link
Contributor

Enhance READMEs for datasource plugins. Note that installation information was missing for a few of these plugins and I have drafted some content based on similar plugins, but this needs to be checked for accuracy.

@josmperez josmperez added the documentation Improvements or additions to documentation label Mar 17, 2024
@josmperez josmperez self-assigned this Mar 17, 2024
@josmperez josmperez requested review from a team as code owners March 17, 2024 23:55
@josmperez josmperez requested review from Ukochka, wbrowne, oshirohugo and xnyo and removed request for a team March 17, 2024 23:55
sympatheticmoose
sympatheticmoose reviewed Apr 17, 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.

Some initial comments

examples/datasource-basic/README.md Outdated Show resolved Hide resolved
examples/datasource-basic/README.md Outdated Show resolved Hide resolved
examples/datasource-basic/README.md Show resolved Hide resolved
examples/datasource-http-backend/README.md Outdated Show resolved Hide resolved
examples/datasource-http/README.md Outdated Show resolved Hide resolved
examples/datasource-streaming-backend-websocket/README.md Outdated Show resolved Hide resolved
examples/datasource-streaming-backend-websocket/README.md Outdated Show resolved Hide resolved
examples/datasource-streaming-backend-websocket/README.md Outdated Show resolved Hide resolved
examples/datasource-streaming-websocket/README.md Show resolved Hide resolved
examples/panel-datalinks/README.md Show resolved Hide resolved
@josmperez josmperez mentioned this pull request Jul 30, 2024
Open
josmperez and others added 10 commits September 12, 2024 12:07
@josmperez @sympatheticmoose
Update examples/datasource-http-backend/README.md
7461145 
Co-authored-by: David Harris <[email protected]>
@josmperez @sympatheticmoose
Update examples/datasource-http/README.md
76f2c6a 
Co-authored-by: David Harris <[email protected]>
@josmperez @sympatheticmoose
Update examples/datasource-logs/README.md
01ee913 
Co-authored-by: David Harris <[email protected]>
@josmperez @sympatheticmoose
Update examples/datasource-streaming-backend-websocket/README.md
cd0e420 
Co-authored-by: David Harris <[email protected]>
@josmperez @sympatheticmoose
Update examples/datasource-streaming-backend-websocket/README.md
fc5cd0c 
Co-authored-by: David Harris <[email protected]>
@josmperez @sympatheticmoose
Update examples/datasource-streaming-backend-websocket/README.md
94a061f 
Co-authored-by: David Harris <[email protected]>
@josmperez
Change first sentence per reviewer feedback
9cda9e3
@josmperez
Reviewer feedback
40e670b
@josmperez
Add link
7127094
@josmperez
Add link to UI components across all DS examples
17d6508
josmperez
josmperez commented Sep 12, 2024
View reviewed changes
Copy link
Contributor Author

@josmperez josmperez left a comment

Choose a reason for hiding this comment

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

Incorporated feedback from reviewers.

examples/datasource-basic/README.md Show resolved Hide resolved
examples/datasource-http/README.md Outdated Show resolved Hide resolved
examples/datasource-http/README.md Outdated Show resolved Hide resolved
examples/datasource-logs/README.md Outdated Show resolved Hide resolved
@josmperez
Copy link
Contributor Author

I found a PR that dropped off my radar screen. I've incorporated feedback from reviwers.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tolzhabayev tolzhabayev tolzhabayev approved these changes

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

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

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

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

@sympatheticmoose sympatheticmoose Awaiting requested review from sympatheticmoose

Assignees

@josmperez josmperez

Labels
documentation Improvements or additions to documentation
Projects
Plugins Platform / Grafana Community
Status: 🔬 In review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@josmperez @CLAassistant @tolzhabayev @oshirohugo @sympatheticmoose