Skip to content

Docs — Customize inventory & findings lists#581

Merged
validbeck merged 12 commits intomainfrom
beck/sc-7685/documentation-save-model-inventory-configuration
Dec 11, 2024
Merged

Docs — Customize inventory & findings lists#581
validbeck merged 12 commits intomainfrom
beck/sc-7685/documentation-save-model-inventory-configuration

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Dec 9, 2024

Internal Notes for Reviewers

sc-7685

@gtagle @even-steven Can one of you review to make sure the info below is accurate and approve if so? Thank you! 🙏🏻

Customize model inventory layout

Revamped this to accommodate the new custom inventory views:

LIVE PREVIEW

View and filter model findings

Revamped this to accommodate the new custom findings views, mostly old info with a new section at the bottom:

LIVE PREVIEW

UI Renames

Where it was applicable, I changed:

  • Model Inventory > Inventory
  • Model Findings > Findings (for all findings, left model-specific findings as is)

@validbeck validbeck added the internal Not to be externalized in the release notes label Dec 9, 2024
@validbeck validbeck self-assigned this Dec 9, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 9, 2024

PR Summary

This pull request updates the terminology used across various documentation files from 'Model Inventory' to 'Inventory'. This change is applied consistently throughout the user guides, style guides, FAQs, and release notes. The update aims to streamline the terminology and improve clarity for users navigating the platform. Additionally, the term 'Model Findings' has been updated to 'Findings' in relevant sections to maintain consistency.

The changes affect multiple files, including:

  • User guides and training materials
  • Style guides and contributing documents
  • Release notes and highlights
  • FAQ and overview documents

The updates ensure that all references to the model inventory are consistent with the new terminology, enhancing the user experience and reducing potential confusion.

Test Suggestions

  • Verify that all instances of 'Model Inventory' have been updated to 'Inventory' across all documentation files.
  • Check for any broken links or references that might have been affected by the terminology change.
  • Ensure that the updated terminology is reflected in the platform's user interface, if applicable.
  • Review the documentation for consistency in the use of 'Findings' instead of 'Model Findings'.
  • Test the navigation instructions in the documentation to ensure they are still accurate and clear.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 9, 2024

PR Summary

This pull request updates the terminology used across various documentation files from 'Model Inventory' to 'Inventory'. This change is applied consistently throughout the user guides, style guides, FAQs, and release notes. The update aims to streamline the terminology and improve clarity for users navigating the documentation. Additionally, the term 'Model Findings' has been updated to 'Findings' in relevant sections to maintain consistency.

The changes affect multiple files, including:

  • User guides and training materials
  • Style guides and conventions
  • FAQ and release notes
  • Various markdown files related to model documentation, validation, and inventory management

These updates ensure that all references to the model inventory are consistent with the new terminology, enhancing the user experience and reducing potential confusion.

Test Suggestions

  • Verify that all instances of 'Model Inventory' have been updated to 'Inventory' across all documentation files.
  • Check for any broken links or references that might have been affected by the terminology change.
  • Ensure that the updated terminology does not affect the functionality of any embedded scripts or templates.
  • Review the documentation for consistency in the use of the new terminology.
  • Test the navigation and search functionality in the documentation to ensure users can still find relevant information with the updated terms.

@github-actions
Copy link
Copy Markdown
Contributor

A PR preview is available: Preview URL

@gtagle
Copy link
Copy Markdown
Collaborator

gtagle commented Dec 11, 2024

@validbeck great work.
Question, I saw filtering "Filter and sort model findings" but I did not see anything similar for the Model Inventory. If missing, I think this PR should include as it is an important part of the new Saving Views functionality, the fact that you don't have to replicate your sorts and filters every time rather just select the saved view from the menu.

@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented Dec 11, 2024

Question, I saw filtering "Filter and sort model findings" but I did not see anything similar for the Model Inventory. If missing, I think this PR should include as it is an important part of the new Saving Views functionality, the fact that you don't have to replicate your sorts and filters every time rather just select the saved view from the menu.

@gtagle It's linked to in the footnote! Here:

Screenshot 2024-12-11 at 8 48 36 AM

LINK: Working with the model inventory

@gtagle
Copy link
Copy Markdown
Collaborator

gtagle commented Dec 11, 2024

@gtagle It's linked to in the footnote! Here:

Ahh that makes sense, it just wasn't as prominent as it was for the Findings. All good then!

Copy link
Copy Markdown
Collaborator

@gtagle gtagle left a comment

Choose a reason for hiding this comment

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

Good to go

@validbeck validbeck merged commit d41b577 into main Dec 11, 2024
@validbeck validbeck deleted the beck/sc-7685/documentation-save-model-inventory-configuration branch December 11, 2024 17:39
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