Skip to content

Added attachment field type #442

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 24, 2024
Merged

Added attachment field type #442

merged 3 commits into from
Sep 24, 2024

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Sep 24, 2024 •
edited
Loading

Internal Notes for Reviewers

sc-6602

Confirmed that we are only adding the model inventory field type to models at the moment, not present on documentation/reports/workflows/etc.

LIVE PREVIEWS

Manage model inventory fields: LINK
Edit model inventory fields: LINK

@validbeck validbeck added the internal Not to be externalized in the release notes label Sep 24, 2024
@validbeck validbeck self-assigned this Sep 24, 2024
@validbeck validbeck requested a review from nrichers September 24, 2024 18:02
@github-actions GitHub Actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation for managing model inventory and validation within the project. The key changes include:

  1. Attachment Management for Models:

    • Added a new section on managing supporting documentation for models, including steps to add and remove attachments.
    • Introduced a new inventory field type, Attachments, allowing users to upload supporting files for models with a size limit of 50 MB.

  2. Attachment Management for Findings:

    • Updated the documentation to include detailed steps for adding and removing attachments from findings.

  3. Minor Enhancements:

    • Added the class="screenshot" attribute to several image tags to improve styling consistency.
    • Updated references and footnotes to ensure accuracy and completeness.

These changes aim to improve the usability and clarity of the documentation, making it easier for users to manage attachments within their model inventory and validation processes.

Test Suggestions

  • Verify that the new sections on managing attachments for models and findings are correctly rendered in the documentation.
  • Check that the steps for adding and removing attachments are clear and accurate.
  • Ensure that the new Attachments inventory field type is correctly documented and that the file size limit is mentioned.
  • Confirm that the images with the class="screenshot" attribute are styled correctly and consistently across the documentation.
  • Validate that all footnotes and references are accurate and lead to the correct sections.

@github-actions GitHub Actions
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

A PR preview is available: Preview URL

nrichers
nrichers approved these changes Sep 24, 2024
View reviewed changes
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@validbeck validbeck merged commit 62b5cfb into main Sep 24, 2024
3 checks passed
@validbeck validbeck deleted the beck/sc-6602/documentation-user-should-be-able-to-define branch September 24, 2024 23:34
nrichers added a commit that referenced this pull request Oct 3, 2024
@nrichers @github-actions
@validbeck @johnwalz97
Merge staging into prod (#462)
fcadf24 
* Fix staging deploy in Makefile (#428)

* Simplify merge strategy for staging (#373)

* Simplify merge strategy

* Minor workflow tweaks

* Switch to test branches

* Add comment to trigger workflow

* Add comment to trigger workflow

* Add comment to trigger workflow

* Switch to squash merge

* Add comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Try --ff strategy

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Revert to --no-ff strategy

* Try reset --hard

* Switch to --merge for PRs

* Switch back to merge --no-ff

* Try merge --ff again

* Add test comment to trigger workflow

* Switch back to merge --no-ff

* Add test comment to trigger workflow

* Switch back to squash merging for PRs

* Add test comment to trigger workflow

* Remove test comments

* Revert to --merge for PRs

* Testing PR#373 - push to branch from local

* Add comment to trigger workflow

* Add comment to trigger workflow

* Add comment to trigger workflow

* Switch to squash merge

* Add comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Remove comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Switch to --merge for PRs

* Add test comment to trigger workflow

* Add test comment to trigger workflow

* Switch back to squash merging for PRs

* Add test comment to trigger workflow

* Remove test comments

* Revert to --merge for PRs

* Undo test changes

* Undo test comment

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* I'm dumb (#431)

* Fix branch in merge-main-into-staging.yaml (#432)

* Styled screenshots & cleaned up current screenshots (#420)

* Added a .screenshot CSS class

* Sample image

* Changed class for About -releases

* Changed class for Get Started & edited images to be uniform

* Changed class for guides/configuration

* Changed class for guides/model-workflows

* Changed class for guides/model-inventory

* Changed class for guides/model-documentation

* Changed class for guides/model-validation

* Changed class for guides/monitoring

* Changed class for developer/

* Changed class for releases/ 1st pass

* Cropped images for 2024-may-22 -1 gif

* Reverting changes for a gif to crop again

* Cropped images for releases 2nd pass

* Cropped images for releases 3rd  pass

* Cropped images for releases 4th pass

* More tweaks

* Videos styling

* Tweaks to JH quickstart

* More cropping

* Applied class to training

* Annotated screenshots in guides/

* Currency field type (#423)

* Preview of Generate with AI docs sections (#419)

* Preview of Generate with AI docs sections

* Release notes draft

* Image edits

* Editing release

* Release notes done

* Final tweaks + new gif

* Oops I lied

* anchor links

* Added attachment field type (#442)

* Added attachment field type

* Wording tweak

* Missed one

* Pulling in latest from developer-framework PR#195 (#438)

* Pulling in latest from developer-framework

* Added .screenshot class to model inventory fields

* Added aliases for index.html & training-overview.html (#444)

* Docs: Work with metrics over time (#449)

* WIP

* Key concepts draft

* Clarified  monitoring instructions now w/ accurate default permissions

* Final draft of Work with metrics over time

* Adjusted Work with content blocks

* Fixing display issue for test description listings on monitoring

* Update site/guide/monitoring/work-with-metrics-over-time.qmd

Co-authored-by: John Halz <johnwalz97@gmail.com>

---------

Co-authored-by: John Halz <johnwalz97@gmail.com>

* Templates for videos (#415)

* Add docs.validmind.ai/training redirect

* Update backgrounds, remove slide numbering, add slide links

* Add initial presentation with sample intro slides

* Add slides

* Update video slides

* Hide controls

* Organize slides into sections by type

* Minor update for adding tests

* Calculation field instructions & example (#443)

* Calculation field instructions & example

* Tweak

* Moved calculation screenshot into its own line

* Added Juan's magic formula

* Set up backfilled redirects for renamed pages (#454)

* 1st pass of links that used to be on developer-framework

* 1st pass of other external links to docs

* 1st pass of newer renames

* Big restructure of guides alias links 1st pass

* Restructure of Documenting models 1st pass

* 2nd pass of big restructure

* Final pass of big restructure

* Added alias redirects to style guide

* Embed Validating Models 101 playlist into Guides section (#446)

* Embed Validating Models 101 playlist into Guides section

* Remove whitespace

* Update site/guide/guides.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Update site/guide/guides.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Undo lead-in text for video

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Embed "How do I ... add tests?" video in developer docs (#450)

* Add how do I add test video

* Switch to iframe for video embed

---------

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>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: John Halz <johnwalz97@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nrichers nrichers nrichers approved these changes

Assignees

@validbeck validbeck

Labels
internal Not to be externalized in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@validbeck @nrichers