notebooks in docs: Added updated copyright footer#1114
Conversation
PR SummaryThis pull request updates the phrasing used in many files across the repository that reference the LICENSE file. The text previously stated "See the LICENSE file in the root of this repository for details." and now has been changed to "Refer to the LICENSE file in the root of this repository for details.". This change ensures a more consistent and possibly more formal tone across all documentation, tests, notebooks, and configuration files without modifying any functional aspects of the codebase. Test Suggestions
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 86dfa40 Modify the workflow to check a different depth:
|
Execute training notebooks for PRs✓ INFO: Live previews are available — |
nrichers
left a comment
There was a problem hiding this comment.
LGTM! Thank you for making our copyright notice more inclusive by changing from "see" to "refer". 👍
* docs: Show model stakeholder updates in model activity (#1078) * Edit: View model activity * Edit * docs: Ability to cancel pending user invitations (#1080) * Edit: Manage users * Edit training * docs: Export documents in PDF (#1081) * Edit: Export documents * Footnotes & cleanup * Edit: Configure workflows (#1086) * Remove support number (#1085) * Nrichers/sc 13410/documentation use custom fields in model (#1074) * Move callout for lazy readers, minor edit * Initial topic updates * Move shared file to match our de facto convention, fix typo, add margin links * Break filter content out into its own topic * Experiment with buttons * Edits, edits, edits * Add more imbed examples for the review * Lots more edits * Edits * Edits * Text edits * Minor text tweaks * Formatting tweaks * Add .callout-button styles * Fix active/inactive tabset text colors * Split steps in examples * Attempt a fix at transparency issue in callouts * Formatting tweaks * Remove YAML header * Address review feedback * Add wrapper topic for help links from the UI * Move select your filters files into shared/ folder * Style + instruction edits * Undo file rename & move images --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * file rename: Select your filters > Work with filters (#1093) * Select your filters > Work with filters * Replace * Preview for 26.01 release notes & make get-source (#1091) * Preview for 26.01 release notes * Update .github/workflows/validate-docs-site.yaml * Documentation - Attestations enhancements (#1090) * Initial set of docs changes for improved attestation process * Updated task topics and edits * Minor edits * Improve owner + group explanations * Remove column experiment * Edits * Update prerequisites * Add animated GIF * Embed animated GIF in overview topic & tweak mermaid diagram * Add collapsible section, hint about group filtering * What could docs & training for AI governance look like? (#1087) * Initial content generation experiment * Content hacking * More edits * Edits * Edits * Minor edits * Put use cases under umbrella categories * Consistency edits, content improvements * Update home page & edits * Fix børked links * Simplify title * Change links to margin footnotes, other formatting fixes * Massaging text for .tour-bg * AI governance local edits * EU AI Act edits * Model risk management edits * Library and platform edits * Use case compliance include * SR 11-7 edit * SS1/23 edit * E-23 edit * Training: Consistency & subtitle card edits * Training: Minor styling edit * Update site/about/use-cases/model-risk-management.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Rename topic to match short title * Remove latinisms * Update site/about/overview.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/about/use-cases/ai-governance.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/about/use-cases/ai-governance.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Address review comments * Minor addition to E-23 guide --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Edit: Workflow Approval conditional requirements (#1099) * docs: Edit use cases expanded functionality (#1101) * Edit: Manage use cases * Training edit * docs: Helper text for inventory & artifact fields (#1104) * Edit: Add & edit inventory fields docs * Edit: Add & edit inventory fields training * Edit: Add & edit artifact fields docs * Edit: Add & edit artifact fields training * Proofreading * Proofreading x2 * Add copyright header to docs source files (#1106) * Add make copyright and verify-copyright actions, add to workflow & readme * Fix issue with not all files missing the header being output * Add count for files missing copyright headers * Fix bug where headers weren't being added to all files * Run copyright check right after repo checkout * Update README.md with better copyright header instructions * Exclude certain folders * Fix bugs, exlcude more files * Fix bugs, better output * Rename make action script, better sorting * Fix regression for underscored files * Better handling for different file types * Update README.md and message with updated make action name * Add dual license notice from library repo * Add copyright headers * Fix bug when script is run with no copyright changes needed * Add message when no updates are needed. * Fix duplicate header bug * Migrate from Heap to Datadog for analytics tracking (#1103) * Initial switch to Datadog for staging & prod * Update README.md * Break out Docker container into its own application * Update README.md for new Docker tracking * Add make copyright and verify-copyright actions, add to workflow & readme * Update README.md Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Remove old copyright script * Remove old version of validate workflow change --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: UI improvements to Calculation fields (#1110) * ABC field types * Metadata-level conditionals: Calculation field examples * Updating example for inventory calculation * Save point * Updating example for artifact calculation * Proofreading * Proofread x2 * Save point * ugh * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edit * One more * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * docs: Standardise support email & URL (#1112) * Support email variable * Changing instances to variable * URL variable too * Oops * variable doesn't work in listing card paths * Edit * one more * Adjusting the variables * Mailto exception * notebooks in docs: Added updated copyright footer (#1114) * Update copyright wording to align with style guide * Pulling in updated notebooks from branch * Updating copyright files * Add custom URL configuration button (#1116) * Add initial custom URL configuration button * Remove temporary file * Move new CSS into slides.scss * Explicitly state format for non-revealjs files to avoid double outputs * Move include-in-header directive into revealjs files * Remove Latinism, make sampe URL more generic * Fix placeholder * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs notebooks: Updating copyright footer again (#1117) * Updated notebooks from branch * Pulling in updated notebooks again * Enable custom URLs, take 2 (#1120) * Add initial custom URL configuration button * Remove temporary file * Move new CSS into slides.scss * Explicitly state format for non-revealjs files to avoid double outputs * Move include-in-header directive into revealjs files * Remove Latinism, make sampe URL more generic * Fix placeholder * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Address review comments * Button text & alignment --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * "Claude PR Assistant workflow" * "Claude Code Review workflow" * Enable manual trigger for Claude Code Review workflow Updated workflow to allow manual triggering and commented out pull request triggers. * nrichers/sc 13645/documentation bedrock poc integration (#1123) * Add Cursor rule for creating user documentation * Add Shortcut epic info * Uncloak and update integrations docs with AWS Bedrock example * Add tab for Bedrock to configure connections topic * Additional missed updates * "What is ValidMind?" product tour, part (#1109) * Move product tour folder into documentation repo * Add missing assets, fix SCSS, add registration page, image * Add copyright headers * Minor heading tweak * Restructured, reworked, revitalized * Fix output filename to get around global HTML output settings required by _metadata.yml * Remove registration from use case courses, replace button * Edits * Minor edit * Rough in new look * Fix font * Reorder content page * Consistency edits, fix broken link * Add tilt effect, edits * Edits, change .bg-dark-green to dark teal * Remove output folder * Edits * So many edits * Edits * Edits * Edits * Background image test * Edits, add more images * Make images transparent, fix arrow orientation * Add pause button * Reorder contents page * Edits, s-shape experiment * Edits, make more image backgrounds transparent * Edits * Remove auto-slide, add target=_blank for links, rework footer * More footer tweaks * Edits, update dark pink colour to VM colour * Add section indicators * Address more review comments * Yet more edits to address review comments * Edits, tweaks, rain dance * Tinker with subtle radial gradient, rotate s-shape * Update s-shape again, tweaks * Add copyright headers * Update learning paths page, product tour registration page, and fix typo * Edits * Tweak * Tweak2 * Edit as per Slack convo * Yeet placeholder product tour * Whitespace Tetris * One last weird alignment * Slide title & link should match * Add content tile linking and comment out one-off footer --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Add initial AWS Marketplace docs (#1129) * Nrichers/sc 14177/add aws marketplace docs (#1132) * Add initial AWS Marketplace docs * Add login link * nrichers/sc 13491/documentation expose search filter on model activity page (#1124) * Add Cursor rule for creating user documentation * Add Shortcut epic info * Initial draft * Enable pull request triggers for code review workflow * Documentation - Attestation Enhancements 1.2 (#1135) * Initial draft * Unbold UI elements * Edits * Remove unused images * Edits * Remove another screenshot * Remove more screenshots * Remove another screenshot & references * Fix easter egg * Update screenshots * docs: Stepped request fields in workflows User Action v2 step (#1138) * User Action v2 mulitple steps setup * Updating example image * Using VM for Model Risk Management > Risk Management * oops * Updated example as per Rod's suggestion * Preview for 26.02 release notes + `make get-source` (#1130) * Add initial AWS Marketplace docs * Add 26.02 release notes branch * Run make get-source * Add excluded categories for latest features on home page * Apply suggestion from @nrichers --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> 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: Andres Rodriguez <andresr83@gmail.com> Co-authored-by: Andres Rodriguez <andres@validmind.ai>
* docs: Show model stakeholder updates in model activity (#1078) * Edit: View model activity * Edit * docs: Ability to cancel pending user invitations (#1080) * Edit: Manage users * Edit training * docs: Export documents in PDF (#1081) * Edit: Export documents * Footnotes & cleanup * Edit: Configure workflows (#1086) * Remove support number (#1085) * Nrichers/sc 13410/documentation use custom fields in model (#1074) * Move callout for lazy readers, minor edit * Initial topic updates * Move shared file to match our de facto convention, fix typo, add margin links * Break filter content out into its own topic * Experiment with buttons * Edits, edits, edits * Add more imbed examples for the review * Lots more edits * Edits * Edits * Text edits * Minor text tweaks * Formatting tweaks * Add .callout-button styles * Fix active/inactive tabset text colors * Split steps in examples * Attempt a fix at transparency issue in callouts * Formatting tweaks * Remove YAML header * Address review feedback * Add wrapper topic for help links from the UI * Move select your filters files into shared/ folder * Style + instruction edits * Undo file rename & move images --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * file rename: Select your filters > Work with filters (#1093) * Select your filters > Work with filters * Replace * Preview for 26.01 release notes & make get-source (#1091) * Preview for 26.01 release notes * Update .github/workflows/validate-docs-site.yaml * Documentation - Attestations enhancements (#1090) * Initial set of docs changes for improved attestation process * Updated task topics and edits * Minor edits * Improve owner + group explanations * Remove column experiment * Edits * Update prerequisites * Add animated GIF * Embed animated GIF in overview topic & tweak mermaid diagram * Add collapsible section, hint about group filtering * What could docs & training for AI governance look like? (#1087) * Initial content generation experiment * Content hacking * More edits * Edits * Edits * Minor edits * Put use cases under umbrella categories * Consistency edits, content improvements * Update home page & edits * Fix børked links * Simplify title * Change links to margin footnotes, other formatting fixes * Massaging text for .tour-bg * AI governance local edits * EU AI Act edits * Model risk management edits * Library and platform edits * Use case compliance include * SR 11-7 edit * SS1/23 edit * E-23 edit * Training: Consistency & subtitle card edits * Training: Minor styling edit * Update site/about/use-cases/model-risk-management.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Rename topic to match short title * Remove latinisms * Update site/about/overview.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/about/use-cases/ai-governance.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/about/use-cases/ai-governance.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Address review comments * Minor addition to E-23 guide --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Edit: Workflow Approval conditional requirements (#1099) * docs: Edit use cases expanded functionality (#1101) * Edit: Manage use cases * Training edit * docs: Helper text for inventory & artifact fields (#1104) * Edit: Add & edit inventory fields docs * Edit: Add & edit inventory fields training * Edit: Add & edit artifact fields docs * Edit: Add & edit artifact fields training * Proofreading * Proofreading x2 * Add copyright header to docs source files (#1106) * Add make copyright and verify-copyright actions, add to workflow & readme * Fix issue with not all files missing the header being output * Add count for files missing copyright headers * Fix bug where headers weren't being added to all files * Run copyright check right after repo checkout * Update README.md with better copyright header instructions * Exclude certain folders * Fix bugs, exlcude more files * Fix bugs, better output * Rename make action script, better sorting * Fix regression for underscored files * Better handling for different file types * Update README.md and message with updated make action name * Add dual license notice from library repo * Add copyright headers * Fix bug when script is run with no copyright changes needed * Add message when no updates are needed. * Fix duplicate header bug * Migrate from Heap to Datadog for analytics tracking (#1103) * Initial switch to Datadog for staging & prod * Update README.md * Break out Docker container into its own application * Update README.md for new Docker tracking * Add make copyright and verify-copyright actions, add to workflow & readme * Update README.md Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Remove old copyright script * Remove old version of validate workflow change --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: UI improvements to Calculation fields (#1110) * ABC field types * Metadata-level conditionals: Calculation field examples * Updating example for inventory calculation * Save point * Updating example for artifact calculation * Proofreading * Proofread x2 * Save point * ugh * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edit * One more * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * docs: Standardise support email & URL (#1112) * Support email variable * Changing instances to variable * URL variable too * Oops * variable doesn't work in listing card paths * Edit * one more * Adjusting the variables * Mailto exception * notebooks in docs: Added updated copyright footer (#1114) * Update copyright wording to align with style guide * Pulling in updated notebooks from branch * Updating copyright files * Add custom URL configuration button (#1116) * Add initial custom URL configuration button * Remove temporary file * Move new CSS into slides.scss * Explicitly state format for non-revealjs files to avoid double outputs * Move include-in-header directive into revealjs files * Remove Latinism, make sampe URL more generic * Fix placeholder * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs notebooks: Updating copyright footer again (#1117) * Updated notebooks from branch * Pulling in updated notebooks again * Enable custom URLs, take 2 (#1120) * Add initial custom URL configuration button * Remove temporary file * Move new CSS into slides.scss * Explicitly state format for non-revealjs files to avoid double outputs * Move include-in-header directive into revealjs files * Remove Latinism, make sampe URL more generic * Fix placeholder * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/training/assets/vmurl-settings.js Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Address review comments * Button text & alignment --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * "Claude PR Assistant workflow" * "Claude Code Review workflow" * Enable manual trigger for Claude Code Review workflow Updated workflow to allow manual triggering and commented out pull request triggers. * nrichers/sc 13645/documentation bedrock poc integration (#1123) * Add Cursor rule for creating user documentation * Add Shortcut epic info * Uncloak and update integrations docs with AWS Bedrock example * Add tab for Bedrock to configure connections topic * Additional missed updates * "What is ValidMind?" product tour, part (#1109) * Move product tour folder into documentation repo * Add missing assets, fix SCSS, add registration page, image * Add copyright headers * Minor heading tweak * Restructured, reworked, revitalized * Fix output filename to get around global HTML output settings required by _metadata.yml * Remove registration from use case courses, replace button * Edits * Minor edit * Rough in new look * Fix font * Reorder content page * Consistency edits, fix broken link * Add tilt effect, edits * Edits, change .bg-dark-green to dark teal * Remove output folder * Edits * So many edits * Edits * Edits * Edits * Background image test * Edits, add more images * Make images transparent, fix arrow orientation * Add pause button * Reorder contents page * Edits, s-shape experiment * Edits, make more image backgrounds transparent * Edits * Remove auto-slide, add target=_blank for links, rework footer * More footer tweaks * Edits, update dark pink colour to VM colour * Add section indicators * Address more review comments * Yet more edits to address review comments * Edits, tweaks, rain dance * Tinker with subtle radial gradient, rotate s-shape * Update s-shape again, tweaks * Add copyright headers * Update learning paths page, product tour registration page, and fix typo * Edits * Tweak * Tweak2 * Edit as per Slack convo * Yeet placeholder product tour * Whitespace Tetris * One last weird alignment * Slide title & link should match * Add content tile linking and comment out one-off footer --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Add initial AWS Marketplace docs (#1129) * Nrichers/sc 14177/add aws marketplace docs (#1132) * Add initial AWS Marketplace docs * Add login link * nrichers/sc 13491/documentation expose search filter on model activity page (#1124) * Add Cursor rule for creating user documentation * Add Shortcut epic info * Initial draft * Enable pull request triggers for code review workflow * Documentation - Attestation Enhancements 1.2 (#1135) * Initial draft * Unbold UI elements * Edits * Remove unused images * Edits * Remove another screenshot * Remove more screenshots * Remove another screenshot & references * Fix easter egg * Update screenshots * docs: Stepped request fields in workflows User Action v2 step (#1138) * User Action v2 mulitple steps setup * Updating example image * Using VM for Model Risk Management > Risk Management * oops * Updated example as per Rod's suggestion * Preview for 26.02 release notes + `make get-source` (#1130) * Add initial AWS Marketplace docs * Add 26.02 release notes branch * Run make get-source * Add excluded categories for latest features on home page * Apply suggestion from @nrichers * Block staging site from search engine indexing (#1143) * Block staging site from search engine indexing Add robots.txt and noindex meta tags to prevent docs-staging.validmind.ai from being indexed by search engines. [sc-14355] * Block development/PR preview environment from search engine indexing Add noindex meta tag and robots.txt to PR preview deployments. [sc-14355] * docs: Documentation PDF upload debt (#1146) * Cleanup: Working with model documentation * Cleanup: Working with model documentation subtopics * Cleanup: Preparing validation reports & subtopics * Cleanup: Manage model documents * Wording adjust * Edit * feat: upgrade libexpat * Add onboarding page image (#1149) --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> 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: Andres Rodriguez <andresr83@gmail.com> Co-authored-by: Andres Rodriguez <andres@validmind.ai> Co-authored-by: Spencer Krum <nibz@validmind.ai>
Pull Request Description
What and why?
While adding the copyright info to the
documentationfiles, we realised that the notebooks that are commonly dispersed to users as "capsule" files do not have this info. This PR:copyright.txtfile that contains the updated copyright info to match what's in the above PR for the same scriptHow to test
Click on any of the notebooks in the "developer" portal in the live preview: ValidMind Library
For example:
What needs special review?
I left the R & .rmd files in
code_sharinguntouched as we don't really share those widely and they are unlikely to get updated further.Dependencies, breaking changes, and deployment notes
Release notes
n/a
Checklist