Skip to content

Update form sources and controls #7538 - #2109

Open
alhambrav wants to merge 13 commits into
craftercms:masterfrom
alhambrav:update-form-sources
Open

Update form sources and controls #7538#2109
alhambrav wants to merge 13 commits into
craftercms:masterfrom
alhambrav:update-form-sources

Conversation

@alhambrav

Copy link
Copy Markdown
Member

Ticket reference or full description of what's in the PR

Update form sources and controls properties presentation craftersoftware/craftercms#7538

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Configuration references for form controls and form data sources were reformatted from shared includes and compact tables into explicit Sphinx list-table structures, with related image alignment, sizing, and asset updates.

Changes

Documentation table modernization

Layer / File(s) Summary
Form control configuration tables
source/.../form-controls/form-*.rst
Form control configuration fields are documented inline under Field Basics, Properties, Constraints, and Related Data Sources.
Specialized control table layouts
source/.../form-controls/form-repeating-group.rst, form-rte.rst, form-section.rst, form-text-area.rst, form-time.rst, form-transcoded-video.rst, form-video.rst
Specialized controls receive structured table headers, grouped rows, and related-source entries.
Basic form source tables
source/.../form-sources/form-source-{audio,components,embedded-content,file,image,kvp}*.rst
Basic form source configuration properties are rendered with explicit list-tables and revised image directives.
External form source tables
source/.../form-sources/form-source-{s3,shared-content,simple-taxonomy,video,webdav}*.rst
S3, shared-content, taxonomy, video, and WebDAV configuration references use structured tables and updated image presentation.
Configuration image assets
source/_static/images/form-sources/*.webp
Two configuration WebP assets were replaced with updated binary contents.

Estimated code review effort: 2 (Simple) | ~15 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise and matches the main change: updating form sources and controls.
Description check ✅ Passed The description uses the required template heading and includes the ticket reference and a clear summary.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 9

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@source/by-role/developer/common/content-modeling/form-controls/form-dropdown.rst`:
- Around line 64-65: Remove the empty table row represented by the standalone “*
-” and “-” lines in the form-dropdown documentation, leaving the surrounding
table structure and the “Related Data Sources” content unchanged.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-components.rst`:
- Around line 58-61: Update the Tags entry in the property table to describe how
tags affect which components are accepted or browsable, instead of repeating
“Tags” as its description. Keep the explanation concise and consistent with the
surrounding Content Types documentation.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-image-desktop.rst`:
- Around line 26-28: Update the image directive’s :alt: value near the desktop
form source configuration content to accurately describe the image, replacing
“Form Control Input 1” with “Form Source Image From Desktop Configuration” or an
equivalent page-specific description.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-kvp.rst`:
- Around line 50-51: Update the “Show keys” row in the property table to include
a clear description of the behavior controlled by this option; if the option is
not configurable, remove the row instead.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-mediaconvert-transcode.rst`:
- Around line 46-49: Replace the inconsistent profile descriptions with
grammatical “configured in aws.xml” wording: update both MediaConvert and S3
descriptions in
source/by-role/developer/common/content-modeling/form-sources/form-source-mediaconvert-transcode.rst
lines 46-49, the S3 description in
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-repo.rst
lines 45-46,
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-upload.rst
lines 48-49, and
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-repo.rst
lines 45-46, plus the WebDAV descriptions in
source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-file-upload.rst
lines 47-48,
source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-image-repo.rst
lines 47-48,
source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-image-upload.rst
lines 48-49, and
source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-video-repo.rst
lines 48-49.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-repo.rst`:
- Around line 22-25: Replace the WebDAV configuration image reference with the
S3 configuration screenshot in all three affected files:
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-repo.rst
lines 22-25,
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-upload.rst
lines 25-28, and
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-repo.rst
lines 22-25.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-upload.rst`:
- Around line 46-47: Correct the profile descriptions in
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-upload.rst
lines 46-47,
source/by-role/developer/common/content-modeling/form-source-s3-video-repo.rst
lines 45-46, and
source/by-role/developer/common/content-modeling/form-source-s3-video-upload.rst
lines 48-49 to “S3 profile ID configured in aws.xml.” Update
source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-file-repo.rst
lines 47-48 to “WebDAV profile ID configured in webdav.xml.”
- Around line 23-26: Replace the WebDAV configuration image references with the
appropriate S3-specific assets: use the S3 image-upload asset in
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-upload.rst
lines 23-26, the S3 video-repository asset in
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-video-repo.rst
lines 22-25, and the S3 video-upload asset in
source/by-role/developer/common/content-modeling/form-sources/form-source-s3-video-upload.rst
lines 25-28; preserve the existing image alignment, width, and alt-text
structure.

In
`@source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-video-upload.rst`:
- Around line 46-49: Update the “Profile Id” description in the documentation
table to clearly state that it is the WebDAV profile ID configured in
`webdav.xml`, correcting the current wording without changing the surrounding
entries.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c4f6a70c-e9ce-4b83-89da-9326a47f0f0d

📥 Commits

Reviewing files that changed from the base of the PR and between 0c1503c and 4578728.

📒 Files selected for processing (49)
  • source/by-role/developer/common/content-modeling/form-controls/form-auto-filename.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-checkbox.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-date-time.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-dropdown.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-filename.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-grouped-checkboxes.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-image.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-input.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-internal-name.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-item-selector.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-label.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-locale-selector.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-numeric-input.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-page-order.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-repeating-group.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-rte.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-section.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-text-area.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-time.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-transcoded-video.rst
  • source/by-role/developer/common/content-modeling/form-controls/form-video.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-audio-desktop.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-audio-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-components.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-embedded-content.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-file-browse.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-file-desktop.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-image-desktop.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-image-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-kvp.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-mediaconvert-transcode.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-file-upload.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-image-upload.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-video-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-s3-video-upload.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-shared-content.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-simple-taxonomy.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-video-desktop.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-video-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-file-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-file-upload.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-image-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-image-upload.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-video-repo.rst
  • source/by-role/developer/common/content-modeling/form-sources/form-source-webdav-video-upload.rst
  • source/includes/form-controls/form-control-field-basics.rst
  • source/includes/form-sources/form-source-field-basics.rst
💤 Files with no reviewable changes (2)
  • source/includes/form-sources/form-source-field-basics.rst
  • source/includes/form-controls/form-control-field-basics.rst

Comment thread source/by-role/developer/common/content-modeling/form-controls/form-dropdown.rst Outdated
Comment thread source/by-role/developer/common/content-modeling/form-sources/form-source-kvp.rst Outdated
@alhambrav
alhambrav marked this pull request as ready for review July 23, 2026 13:38
@alhambrav
alhambrav requested a review from sumerjabri July 23, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant