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

Improve Dashboards docs information architecture #80255

Closed
7 tasks done
Tracked by #80244
imatwawana opened this issue Jan 9, 2024 · 0 comments · Fixed by #87844
Closed
7 tasks done
Tracked by #80244

Improve Dashboards docs information architecture #80255

imatwawana opened this issue Jan 9, 2024 · 0 comments · Fixed by #87844
Assignees
Labels
internal for issues made by grafanistas team/grafana-dashboards Dashboards squad type/docs

Comments

@imatwawana
Copy link
Collaborator

imatwawana commented Jan 9, 2024

  • 1. Move Best practices to the bottom Build dashboards section

    • The content is directed at intermediate and advanced users so maybe it should just be at the end of the section after you’ve learned all of what you need to learn to build and use dashboards
  • 2. Repurpose and rename two variables pages
    This section has three pages:

menuTitle (title in TOC) title (on page)
Manage variables Add and manage variables
Inspect variables Inspect variables
Variable syntax Variable syntax
  • Move the paragraph of “manage” content from the Manage variables page to the Inspect variables page
  • Update menuTitle and page title of the Manage variables page to Add variables
  • Update the title of Inspect variables page to Manage and inspect variables; leave menuTitle as is

Justification

  • This keeps everything that’s in the configuration UI on one page and everything on the Variables page UI on another page

  • The original file name of the Manage variables page is add-tempate-variables and the content is primarily about adding them and all the different types that you can add

  • When I was on the Inspect variables page and realized it was about actions you could take on the main Variables page in the UI, I expected to find the rest of the actions I could take on this page here

  • 3. Revamp Manage dashboards page

    • 3a. Create standalone Troubleshoot dashboards page

      • Make the troubleshooting content easier to find when scanning the table of contents
      • Maybe make it more SEO friendly by having a page with that title vs a page section with that title; currently the 9th result when I Google “troubleshoot grafana dashboard”
    • 3b. Remove export content

      • Export content is all covered under Sharing and Reporting
    • 3c. Create standalone Import dashboards page that includes import/discover content

      • Make the import content easier to find when scanning the table of contents
      • Allows more space to document the import options in a more detailed way
Before After
image
image
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 team/grafana-dashboards Dashboards squad type/docs
Projects
Status: 🚀 Done
Development

Successfully merging a pull request may close this issue.

2 participants