Skip to content

Updated Roadside Turf documentation Grafana SQL#1

Open
piotr063 wants to merge 2 commits intomainfrom
updated-documentation
Open

Updated Roadside Turf documentation Grafana SQL#1
piotr063 wants to merge 2 commits intomainfrom
updated-documentation

Conversation

@piotr063
Copy link

I've updated the Grafana SQL documentation for the Roadside Turf organization. If the team could review this version and give feedback, once we have an acceptable template for one organization, I can complete the remaining. This is also my first attempt at branching/PR with GitHub, any comments on how to improve this process is also welcomed.

piotr063 added 2 commits July 21, 2025 10:40
Changed file structure and added documentation for 'roadside turf' organization as a demo of what the updated documentation will look like across organizations.
cleanup readme
@piotr063 piotr063 requested review from runck014 and zradlicz July 21, 2025 15:57
Copy link

@zradlicz zradlicz left a comment

Choose a reason for hiding this comment

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

Is your intention to actually merge to the main branch with this? If so I would suggest leaving the all the files and folders not related to Roadside Turf in place. This way, the only changes are the additions of the new Roadside Turf file and the removal of the old Roadside Turf files. This way, you can merge the branch and then create the future changes to the other projects in a new branch.

If the intention is to continue making the future changes in this branch and not merge to the main branch until those are done, then I would suggest making this a 'draft' pull request which will make it so that it doesn't accidentally get merged with all the files deleted. That way we can review the format change example of Roadside Turf, and then you can make it a real Pull Request once all of the projects are changed.

Copy link

@zradlicz zradlicz left a comment

Choose a reason for hiding this comment

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

As far as the overall structure, the new method works way better. Separating the queries into individual files was definitely necessary. I'm not fully aware of how grafana works, but if it is directly pulling from this repo for the queries it is using, you should also make sure that this doesn't break any functionality.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants