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

Docs: create shared content for common options in visualizations #77320

Closed
8 tasks done
Tracked by #78767
imatwawana opened this issue Oct 27, 2023 · 2 comments · Fixed by #87258
Closed
8 tasks done
Tracked by #78767

Docs: create shared content for common options in visualizations #77320

imatwawana opened this issue Oct 27, 2023 · 2 comments · Fixed by #87258
Assignees
Labels
internal for issues made by grafanistas type/docs

Comments

@imatwawana
Copy link
Collaborator

imatwawana commented Oct 27, 2023

Many visualizations have the same common options:

Tasks

For these options, we should be using as much shared content as possible so that we have one source of truth and contributors don't have to keep rewriting the same content. We have some shared content already, but the goal is to cover all of these in all their varieties. In issue #73954, we did the work of documenting how these options are implemented across visualizations and now we can use that work to complete this task.

Common options review
Panel config docs audit observations

Goal: Q4

@imatwawana imatwawana added type/docs internal for issues made by grafanistas labels Oct 27, 2023
@imatwawana imatwawana self-assigned this Oct 27, 2023
@imatwawana imatwawana changed the title Create shared content for common options in visualizations Docs: create shared content for common options in visualizations Oct 27, 2023
@imatwawana
Copy link
Collaborator Author

imatwawana commented Nov 30, 2023

In the course of preparing to do add/update shared files to use on visualization pages and link to more in-depth content from there, it's become clear that some of the panel config documentation will need some amount of updating at this stage. This can either be a quick effort focused on ensuring the pages are an accurate reflection of the UI and that there aren't major gaps OR the full work of restructuring and updating these pages can be moved up in the roadmap. TBD.

@imatwawana
Copy link
Collaborator Author

I'm going to tackle the panel configuration docs updates first and then return to the work of creating and updating shared content for the visualizations documentation.

@imatwawana imatwawana linked a pull request May 2, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal for issues made by grafanistas type/docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant