Skip to content

Docs — Customize model overview page#622

Merged
validbeck merged 3 commits intomainfrom
beck/sc-4752/documentation-implement-customizable-model
Jan 8, 2025
Merged

Docs — Customize model overview page#622
validbeck merged 3 commits intomainfrom
beck/sc-4752/documentation-implement-customizable-model

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Jan 7, 2025

Internal Notes for Reviewers

sc-4752

Customize model overview page

Net-new page: LIVE PREVEW

Screenshot 2025-01-07 at 4 29 29 PM

Added under the "Working with the model inventory umbrella": LIVE PREVEW

Screenshot 2025-01-07 at 4 29 22 PM

@validbeck validbeck added the internal Not to be externalized in the release notes label Jan 7, 2025
@validbeck validbeck self-assigned this Jan 7, 2025
@validbeck validbeck requested a review from nrichers January 8, 2025 00:29
@validbeck
Copy link
Copy Markdown
Collaborator Author

@gtagle For your review! Let me know if there is anything I am missing :)

Customize model overview page

Net-new page: LIVE PREVEW

Screenshot 2025-01-07 at 4 29 29 PM

@validbeck validbeck requested a review from gtagle January 8, 2025 00:30
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 8, 2025

PR Summary

This pull request introduces a new feature that allows users to customize the model overview page within the model inventory. The changes include:

  • Addition of a new guide file customize-model-overview-page.qmd that provides detailed instructions on how to configure the appearance of model inventory fields when viewing a model's details.
  • Updates to the navigation and linking structure in existing documentation files to include references to the new customization guide.
  • The new guide explains how users can show or hide custom inventory fields, rearrange their order, and save these customizations, which apply to all models in their inventory.

These enhancements aim to improve user experience by providing more flexibility in how model information is displayed.

Test Suggestions

  • Verify that the new guide customize-model-overview-page.qmd is accessible from the documentation site.
  • Check that all links to the new guide from other documentation pages are working correctly.
  • Test the functionality described in the guide to ensure users can successfully customize the model overview page as instructed.
  • Ensure that changes made to the model overview page are saved and persist across sessions.
  • Confirm that default fields remain visible and are not affected by customization options.

@gtagle
Copy link
Copy Markdown
Collaborator

gtagle commented Jan 8, 2025

I think the functionality is properly captured in the document. 👍🏼 However, there are a few scenarios that are worth mentioning as users might ran into them and think the feature is not behaving properly.

  • Fields of type "Long text" or "Attachments" will not go in the right hand rail.
  • On the Main Column, you can only place fields in the allowed space, between "Model Interdependencies" and "Model Findings"
  • On the Side Column, you can only place fields after "Vendor Name"

Once we evolve this to also include the management of all sections, the last two conditions above would go away, but I don't think it will ever make sense to support Long Text living in the right hand rail.

@validbeck
Copy link
Copy Markdown
Collaborator Author

@gtagle Thank you! If these updates look good to you can you approve 🙏🏻

Screenshot 2025-01-08 at 10 30 31 AM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 8, 2025

A PR preview is available: Preview URL

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.

This is good to go.

@validbeck validbeck merged commit 8e5bedb into main Jan 8, 2025
@validbeck validbeck deleted the beck/sc-4752/documentation-implement-customizable-model branch January 8, 2025 18:56
validbeck added a commit that referenced this pull request Jan 22, 2025
* Add make execute PROFILE=exe-prod to docs-site action  (#598)

* Add execute PROFILE=exe-prod to Docker image build

* Move notebook execution into docs-site action

* Docs — Customize model overview page (#622)

* Draft customize-model-overview-page.qmd

* Quick instructions

* Edits based on feedback from Rod

* Updated docs — Workflows (#620)

* Tweak to release generation notebook

* Wait, gotta make the file first

* Wording in notebook

* Just being picky about spaces now

* Adding open file to yearly_cleanup.py too

* Success

* Edits to customize-model-lifecycle-statuses.qmd

* New img - working-with-model-workflows.qmd > See workflow statuses

* +reset-workflow.gif to working-with-model-workflows.qmd

* Updated set-up-model-workflows.qmd > Configure workflow steps

* Updated configure-user-action.png

* Updated approval-group-setup.png

* Redid the Approval Step example/images

* Redid the Condition Branch example/images

* Changed linked-workflow image to a gif

* Updated set-up-model-workflows.qmd > Link approval steps

* Changed my mind about the model-workflows.png screencap

* Tweak

* Simplifying based on Rod's suggestion

* QoL improvements to release notes script/notebooks (#626)

* Testing adding the year to generated release notes

* oops, forgot to parse the date format

* Now the folder is swapped ugh

* Adding the year to the _quarto.yml entry

* Oops, forgot to add the input

* Casing

* Adding new year folder to index function

* Grabbing yearly folders in established year

* Fake 2025 releases for testing & modifying Makefile command

* Fake 2026 release for yearly cleanup test

* Trying the yearly lookup again

* Yearly lookup works

* Retrieve year folder

* Commenting out move releases for now

* Removed move releases

* Modifying update_quarto_yaml

* Cleaning up the Makefile command

* Notebook wording cleanup

* Removing test files & reverting _quarto.yml & index.qmd to main

* Added aliases for moved 2024 releases

* Added aliases for moved 2023 releases

* Whoops, wrong alias for some of the super old releases

* Nitpicky edit

* Meh

* Nitpicking the output

* Added instructions for Wait steps in workflows (#628)

* Edits to date & date-time custom fields

* Wait step draft

* Edits & footnotes

---------

Co-authored-by: Nik Richers <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@nrichers nrichers added documentation Improvements or additions to documentation and removed internal Not to be externalized in the release notes labels Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants