Skip to content

[SC-15827] Document configurable attachment upload limits - #1429

Merged
cachafla merged 1 commit into
mainfrom
codex/sc-15827-attachment-upload-limits
Jul 23, 2026
Merged

[SC-15827] Document configurable attachment upload limits#1429
cachafla merged 1 commit into
mainfrom
codex/sc-15827-attachment-upload-limits

Conversation

@cachafla

@cachafla cachafla commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Updates attachment guidance for records and artifacts to replace the outdated fixed 50 MB limit with the new 100 MB default. The copy also directs readers to the limit shown in ValidMind because deployments can configure a different maximum.

This addresses SC-15827 and keeps the field-type reference consistent with the upload guides.

How to test

Rendered the affected pages locally with Quarto using the development profile:

  • guide/inventory/edit-inventory-fields.qmd
  • guide/validation/update-artifacts.qmd
  • guide/inventory/manage-inventory-fields.qmd
  • guide/validation/manage-artifact-fields.qmd

All four pages rendered successfully. The existing unresolved validmind/validmind.qmd link warnings remain unrelated to this change.

Documentation preview

Open the documentation preview. The preview becomes available after the validate check completes successfully.

What needs special review?

Please confirm that describing 100 MB as the default, while deferring to the limit shown in-product for configured deployments, matches the final behavior in the frontend fix.

Dependencies, breaking changes, and deployment notes

Depends on validmind/frontend#2457. The documentation should merge and deploy with or after the frontend behavior.

No breaking changes or special documentation deployment steps.

Release notes

Updated attachment upload guidance to document the new 100 MB default and clarify that the maximum can vary by deployment. Learn more about managing record attachments.

Checklist

  • What and why
  • Screenshots or videos (Frontend) — Not applicable
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend) — Not applicable
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required) — Not applicable; this PR documents the user-visible configurable limit

@cachafla cachafla added the documentation Improvements or additions to documentation label Jul 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR updates the instructional text for file attachment size limits across several guide files. The previous hard-coded limit of 50 MB has been replaced with a default limit of 100 MB per file. Additionally, the revised messages now indicate that the limit displayed in the user interface (using {{< var vm.product >}}) may vary based on the deployment configuration. These changes are applied in multiple files, including inventory and artifact management guides, to ensure consistency and clearer communication to the user.

The changes focus solely on the user-facing text and do not affect the underlying functionality or file upload mechanisms.

Test Suggestions

  • Check that the updated messaging is correctly displayed on the inventory attachments page.
  • Verify the artifact attachments documentation shows the new text indicating 100 MB as the default limit.
  • Test the dynamic display of deployment-specific limits using the {{< var vm.product >}} variable.
  • Ensure that no unintended formatting issues occur in both HTML and revealjs formats.

@cachafla
cachafla marked this pull request as ready for review July 23, 2026 18:09
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.91 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (2 URL(s))

Show Lighthouse scores

Commit SHA: f3a6954

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/inventory/edit-inventory-fields.html 0.90 0.58 1.00 0.82
/guide/inventory/edit-inventory-fields.html 0.90 0.70 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.70 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.70 1.00 0.82
/guide/inventory/edit-inventory-fields.html 0.90 0.70 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.70 1.00 0.82

@cachafla
cachafla enabled auto-merge July 23, 2026 18:45
@gtagle
gtagle self-requested a review July 23, 2026 18:54

@gtagle gtagle left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

👍🏽

@cachafla
cachafla added this pull request to the merge queue Jul 23, 2026
Merged via the queue into main with commit edda3ec Jul 23, 2026
12 checks passed
@cachafla
cachafla deleted the codex/sc-15827-attachment-upload-limits branch July 23, 2026 18:55
@cachafla cachafla added the support Support-related PR label Jul 28, 2026
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 support Support-related PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants