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

GitHub DS Plugin docs #292

Merged
merged 66 commits into from
Jul 23, 2024
Merged

GitHub DS Plugin docs #292

merged 66 commits into from
Jul 23, 2024

Conversation

usmangt
Copy link
Contributor

@usmangt usmangt commented Mar 4, 2024

This PR will create the Official documentation for the Grafana GitHub Datasource plugin which will be visible on the Grafana Docs website.

@CLAassistant
Copy link

CLAassistant commented Mar 4, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@usmangt usmangt added the type/docs Improvements or additions to documentation label Mar 4, 2024
@jdbaldry jdbaldry self-requested a review May 30, 2024 10:08
@usmangt usmangt marked this pull request as ready for review July 3, 2024 20:56
@usmangt usmangt requested a review from a team as a code owner July 3, 2024 20:57
@usmangt usmangt requested review from gabor, zoltanbedi and gwdawson and removed request for a team July 3, 2024 20:57
@usmangt usmangt changed the title created docs folder structure GitHub DS Plugin docs Jul 3, 2024
@usmangt usmangt requested a review from yesoreyeram July 4, 2024 08:29
ivanahuckova
ivanahuckova reviewed Jul 8, 2024
View reviewed changes
Copy link
Member

@ivanahuckova ivanahuckova left a comment

Choose a reason for hiding this comment

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

Left suggestions bellow - mostly related to casing, following https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/

docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/macros.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
usmangt
usmangt commented Jul 9, 2024
View reviewed changes
Copy link
Contributor Author

@usmangt usmangt left a comment

Choose a reason for hiding this comment

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

Thanks @ivanahuckova for reviewing it.

I accepted the changes.

usmangt and others added 2 commits July 9, 2024 11:31
@usmangt @ivanahuckova
Apply suggestions from code review
47b6422 
reviews looks good. Thanks

Co-authored-by: Ivana Huckova <[email protected]>
@ivanahuckova
Fix spell
223a905
usmangt
usmangt commented Jul 16, 2024
View reviewed changes
Copy link
Contributor Author

@usmangt usmangt left a comment

Choose a reason for hiding this comment

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

Made fixes and improvements as requested.

Ready for review

Thank you

docs/sources/examples/_index.md Outdated Show resolved Hide resolved
usmangt and others added 2 commits July 16, 2024 19:56
@ivanahuckova ivanahuckova mentioned this pull request Jul 17, 2024
Closed
jdbaldry
jdbaldry reviewed Jul 17, 2024
View reviewed changes
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 all the hard work so far!

docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/_index.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/macros.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/macros.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
docs/sources/variables-and-macros/variables.md Outdated Show resolved Hide resolved
usmangt
usmangt commented Jul 17, 2024
View reviewed changes
Copy link
Contributor Author

@usmangt usmangt 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 the review. Accepted all the suggestions.

usmangt
usmangt commented Jul 17, 2024
View reviewed changes
Copy link
Contributor Author

@usmangt usmangt left a comment

Choose a reason for hiding this comment

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

ready for review

usmangt
usmangt commented Jul 19, 2024
View reviewed changes
Copy link
Contributor Author

@usmangt usmangt left a comment

Choose a reason for hiding this comment

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

ready for probably final review

docs/sources/examples/_index.md Outdated Show resolved Hide resolved
jdbaldry
jdbaldry reviewed Jul 22, 2024
View reviewed changes
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
docs/sources/sample-dashboards/_index.md Outdated Show resolved Hide resolved
@usmangt @jdbaldry
Apply suggestions from code review
9304ac7 
Thanks. looks good !!

Co-authored-by: Jack Baldry <[email protected]>
@lwandz13 lwandz13 dismissed their stale review July 22, 2024 13:05

doc changed

jdbaldry
jdbaldry approved these changes Jul 23, 2024
View reviewed changes
Copy link
Member

@jdbaldry jdbaldry left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks for working so hard on this

@usmangt usmangt merged commit e214646 into main Jul 23, 2024
10 checks passed
@usmangt usmangt deleted the docs/usman-github-docs branch July 23, 2024 09:06
@usmangt usmangt mentioned this pull request Jul 25, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ivanahuckova ivanahuckova ivanahuckova approved these changes

@yesoreyeram yesoreyeram yesoreyeram left review comments

@jdbaldry jdbaldry jdbaldry approved these changes

@gabor gabor Awaiting requested review from gabor gabor is a code owner automatically assigned from grafana/oss-big-tent

@zoltanbedi zoltanbedi Awaiting requested review from zoltanbedi zoltanbedi is a code owner automatically assigned from grafana/oss-big-tent

@gwdawson gwdawson Awaiting requested review from gwdawson gwdawson is a code owner automatically assigned from grafana/oss-big-tent

@lwandz13 lwandz13 Awaiting requested review from lwandz13

Assignees
No one assigned
Labels
type/docs Improvements or additions to documentation
Projects
OSS Big Tent
Status: Complete
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@usmangt @CLAassistant @yesoreyeram @jdbaldry @ivanahuckova @lwandz13