Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs — Custom reporting#533

Merged
validbeck merged 25 commits intomainvalidmind/documentation:mainfrom
beck/sc-7461/documentation-implement-new-reports-uivalidmind/documentation:beck/sc-7461/documentation-implement-new-reports-uiCopy head branch name to clipboard
Nov 22, 2024
Merged

Docs — Custom reporting#533
validbeck merged 25 commits intomainvalidmind/documentation:mainfrom
beck/sc-7461/documentation-implement-new-reports-uivalidmind/documentation:beck/sc-7461/documentation-implement-new-reports-uiCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Nov 19, 2024

Internal Notes for Reviewers

sc-7461

View reports > Working with analytics

LIVE PREVIEW

  • Retooled old guide/model-validation/view-reports.qmd to guide/reporting/working-with-analytics.qmd to accommodate for the new custom reporting function
  • Aliases have been set up to redirect users to this new page in this new directory
  • Information has been proofread and updated to reflect new Analytics page (new screenshots, etc.)
  • Added a section on rearranging report widgets

View report data

LIVE PREVIEW

  • Moved this information from the old "View reports" page
  • Scrubbed it to apply to the new interface

Manage custom reports

LIVE PREVIEW

  • Net-new page detailing how to add your own custom report page and widget
  • Includes a thorough breakdown of the feature and an example visualization setup

Customize your dashboard

LIVE PREVIEW

I hid the sections on adding and removing report widgets for now as this feature has been temporarily removed.

Other edits

Some references to UI links didn't have the fa-icon so I fixed those.

@validbeck validbeck added the internal Not to be externalized in the release notes label Nov 19, 2024
@validbeck validbeck self-assigned this Nov 19, 2024
@validbeck
Copy link
Collaborator Author

Hey @even-steven, can you take a look at this docs and let me know if the information looks accurate? If so, pls approve 🙏🏻

Manage custom reports

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation and navigation within the project. The main changes include:

  1. FontAwesome Icons Integration: The documentation now uses FontAwesome icons to visually enhance navigation elements. For example, 'Model Inventory' is now displayed as '{{< fa cubes >}} Model Inventory', and 'Model Activity' as '{{< fa wifi >}} Model Activity'. This change is applied across multiple documentation files to improve user experience and consistency.

  2. CSS and YAML Updates: The CSS files have been updated to replace '.fa-tower-broadcast' with '.fa-wifi', ensuring the correct icon is displayed. Similarly, YAML configuration files have been updated to reflect these changes in the navigation structure.

  3. Documentation Structure and Navigation: The documentation structure has been refined, with updates to the sidebar navigation and the addition of new sections such as 'Working with Analytics'. This includes reorganizing content under new headings and improving the clarity of navigation paths.

  4. New Features in Analytics: The analytics section has been expanded with new capabilities for managing custom reports, including adding, editing, and removing custom data visualizations. This allows users to create tailored analytics pages with bar charts, pie charts, and counters.

  5. Miscellaneous Enhancements: Various other improvements include the ability to manage columns in the model inventory, enhanced filtering options, and the introduction of new settings pages for better user management and customization.

Test Suggestions

  • Verify that all FontAwesome icons are displayed correctly in the documentation.
  • Test the navigation links in the documentation to ensure they lead to the correct sections.
  • Check the CSS changes to confirm that the '.fa-wifi' icon is used consistently across all relevant files.
  • Ensure that the new analytics features work as expected, including adding and removing custom visualizations.
  • Test the updated sidebar navigation to confirm that all links are functional and correctly labeled.

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation and navigation within the project. The primary changes include:

  1. FontAwesome Icons Integration: The documentation now includes FontAwesome icons to enhance the visual representation of various sections. For example, 'Model Inventory' is now displayed with a cubes icon, and 'Model Activity' with a wifi icon. This change is applied across multiple documentation files to improve user experience and consistency.

  2. Navigation Updates: The navigation structure has been updated to include new sections and reorganize existing ones. Notably, a new 'Analytics' section has been introduced, replacing the previous 'Reports' section. This includes new pages for managing custom reports and viewing report data.

  3. CSS and Style Adjustments: Minor CSS changes have been made, such as updating the color for certain elements to improve readability and consistency across the site.

  4. Content and Structure Enhancements: Several content files have been updated to reflect the new navigation structure and iconography, ensuring that all documentation is aligned with the latest UI changes.

Test Suggestions

  • Verify that all FontAwesome icons are displayed correctly in the documentation.
  • Check that the navigation links to the new 'Analytics' section work as expected.
  • Ensure that the updated CSS styles are applied consistently across all pages.
  • Test the functionality of adding, editing, and removing custom reports in the 'Analytics' section.
  • Review the documentation for any broken links or outdated references to the old 'Reports' section.

Copy link

@even-steven even-steven left a comment

Choose a reason for hiding this comment

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

Looks good!

@validbeck validbeck merged commit 5a7e901 into main Nov 22, 2024
@validbeck validbeck deleted the beck/sc-7461/documentation-implement-new-reports-ui branch November 22, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.