Move custom schema documentation to pipeline-schema overview by llewellyn-sl · Pull Request #1139 · seqeralabs/docs

llewellyn-sl · 2026-02-17T13:08:41Z

Summary

Moved custom schema section from pipelines/versioning.md to pipeline-schema/overview.md
Renamed section to "Define pipeline schema"
Added documentation for all three schema options:
- Repository default
- Repository path
- Seqera Platform schema
Added note about unique schema id field requirement
Updated cross-references in versioning.md
Applied changes to both Cloud and Enterprise v25.3 docs

Test plan

Verify new section appears correctly in pipeline-schema/overview.md for Cloud and Enterprise v25.3
Verify Custom schema section removed from versioning.md for Cloud and Enterprise v25.3
Verify cross-reference links work correctly
Review rendered documentation in deploy preview

🤖 Generated with Claude Code

Updates pipeline versioning documentation with GA release features: - Add nested parameter support for track_changes at leaf node level - Update terminology from "checksum" to "hash" throughout - Add versionName and versionHash search keywords - Document shared pipeline publishing restrictions - Add pipeline optimization integration section Related to PLAT-4471 (Versioning GA QA Testing) - PLAT-3576: Version search with additional keywords - PLAT-4051: Version hash terminology update - PLAT-3877: Nested schema property support - PLAT-3501: Pipeline optimization integration - PLAT-4090: Shared pipeline publishing behavior Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

…nges - Add custom schema documentation to Cloud and Enterprise 25.3 versioning pages - Remove preview status from Enterprise 25.3 (feature now GA) - Add commit ID pinning recommendation for Enterprise 25.3 - Update shared pipeline editing notes to clarify workspace restrictions - Update pipeline optimization section for non-default version clarity - Remove versioning page from Cloud sidebar (releasing Feb 19) Addresses PR review comments from PLAT-3570 custom schema feature. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

- Add "Define pipeline schema" section to pipeline-schema/overview.md - Document all three schema options: Repository default, Repository path, and Seqera Platform schema - Include detailed instructions for Seqera Platform schema option - Add note about unique schema id field requirement - Remove Custom schema section from pipelines/versioning.md - Update versioning.md references to point to new location - Apply changes to both Cloud and Enterprise v25.3 docs Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

netlify · 2026-02-17T13:08:46Z

✅ Deploy Preview for seqera-docs ready!

Name	Link
🔨 Latest commit	`9d34edc`
🔍 Latest deploy log	https://app.netlify.com/projects/seqera-docs/deploys/6995a0b97eee6c0008385617
😎 Deploy Preview	https://deploy-preview-1139--seqera-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

llewellyn-sl · 2026-02-17T13:09:15Z

@claude please review

claude · 2026-02-17T13:10:19Z

Claude finished @llewellyn-sl's task —— View job

Reviewing PR: Move custom schema documentation

Read CLAUDE.md for repository guidelines (none found)
Review documentation restructuring changes
Check custom schema content migration
Verify cross-reference links
Review sidebar navigation updates
Provide comprehensive feedback

Review Summary

This PR successfully restructures the custom schema documentation with good improvements. The changes are well-executed and improve the organization of the documentation.

✅ Positive Changes

Better logical placement: Moving custom schema docs from versioning.md to pipeline-schema/overview.md creates better topical cohesion
Enhanced content: The new section provides more comprehensive coverage of all three schema options (Repository default, Repository path, Seqera Platform schema)
Improved terminology: "Seqera Platform schema" is clearer than the previous "Custom schema"
Proper cross-referencing: Updated link in versioning.md:45 correctly points to the new location
Consistent application: Changes applied to both Cloud and Enterprise v25.3 documentation

🔍 Minor Issues Found

platform-cloud/docs/pipelines/versioning.md:8-12

Missing tip callout about commit ID pinning that exists in Enterprise version
Enterprise version has a better tip about deterministic execution with commit ID pinning

Content consistency

Both versions should have the same introductory content for consistency

📝 Documentation Quality

The migrated content maintains high quality:

Clear step-by-step instructions for Platform schema setup
Important note about unique id field requirement
Proper formatting and structure
Good use of bullet points for feature lists

🔗 Cross-References Status

✅ versioning.md:45 correctly updated to point to new location
✅ Link structure follows proper relative path format
✅ Fragment identifier #define-pipeline-schema matches new section header

Overall Assessment

This is a well-executed documentation restructuring that improves content organization and adds valuable detail. The changes enhance user experience by consolidating schema-related information in the appropriate location.

Recommendation: ✅ Approved - Consider adding the missing tip callout to Cloud versioning.md for consistency with Enterprise version.

Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>

llewellyn-sl · 2026-02-17T15:24:54Z

@claude I resolved conflicts, that should take care of the missing tip you highlighted in your previous review. Please review again

claude · 2026-02-17T15:25:37Z

Claude finished @llewellyn-sl's task —— View job

Re-reviewing PR after conflict resolution

Read updated changed files
Compare with previous review findings about missing tip
Check content consistency between Cloud and Enterprise versions
Verify cross-reference links still work
Provide updated comprehensive review feedback

✅ Issues Resolved

Great work! The conflict resolution has successfully addressed the content inconsistency issue I identified in my previous review:

Cloud vs Enterprise versioning.md consistency:

✅ Cloud version now includes the missing tip callout (lines 10-12): The preview feature info callout is now present, providing important context about pipeline versioning being a preview feature
✅ Content alignment: Both versions now have appropriate introductory content, though slightly different due to the preview status difference

✅ Continued Strengths

All the positive aspects from my previous review remain intact:

Excellent content migration: Custom schema documentation successfully moved from versioning.md to pipeline-schema/overview.md
Enhanced documentation: The new "Define pipeline schema" section (lines 14-43 in both overview.md files) provides comprehensive coverage of all three schema options
Improved terminology: "Seqera Platform schema" is much clearer than the previous "Custom schema"
Perfect cross-referencing: Links in versioning.md:45 (Cloud) and versioning.md:46 (Enterprise) correctly point to the new location
Consistent application: Changes properly applied across both Cloud and Enterprise v25.3 documentation

🔍 Current State Analysis

Cross-reference verification:

✅ versioning.md:45 → ../pipeline-schema/overview.md#define-pipeline-schema (working)
✅ versioning.md:46 → ../pipeline-schema/overview.md#define-pipeline-schema (working)
✅ Fragment identifier matches the new section header exactly

Content quality:

✅ Clear step-by-step instructions for Platform schema setup
✅ Important note about unique id field requirement (overview.md:41-43)
✅ Proper formatting and structure maintained
✅ Good use of callouts and bullet points

Final Assessment

Recommendation: ✅ Approved - All previous issues have been resolved. The conflict resolution successfully addressed the content inconsistency, and the PR now provides a clean, well-structured documentation improvement that enhances user experience by consolidating schema-related information in the logical location.

The documentation restructuring is complete and ready for merge.

Updates versioning documentation to clarify that resource labels are excluded from triggering new pipeline versions, alongside name, image, description, and labels. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

swingingsimian · 2026-02-18T13:22:02Z

platform-enterprise_versioned_docs/version-25.3/pipelines/versioning.md


 Seqera maintains a history of all draft and published versions, providing an audit trail of pipeline evolution.

 #### Custom schema


This section needs updating to reflect the new usage of 'Seqera Platform schema' rather than custom schema. Some of this can also be trimmed out as it replicate what is precent in the pipeline-schema/overview.md. We should link to that from here. Same goes for cloud docs obvs.

swingingsimian · 2026-02-18T13:26:42Z

platform-enterprise_versioned_docs/version-25.3/pipeline-schema/overview.md

+2. **Repository path**: Use a schema at a specific path in the repository.
+3. **Seqera Platform schema**: Use a Nextflow JSON schema stored in Seqera Platform (overrides repository).
+
+The selected schema controls which pipeline parameters are exposed in the launch form. This allows you to restrict the parameters visible to launch users, simplifying the launch experience and preventing modification of parameters that should remain fixed.


'prevent' is a strong word here. The user is still able to edit the config view directly. The launch form defined by the schema can hide parameters which the pipeline maintain wishes not to be fiddled with, but it cannot prevent direct specification in the config view. Actually, let me double check that.

Actually this is correct, it's possible to hide a parameter, set a default and a validation which only validates the default.

swingingsimian · 2026-02-18T13:28:39Z

platform-enterprise_versioned_docs/version-25.3/pipeline-schema/overview.md

+5. Select **Add** or **Save** to create a new draft version with the Platform schema
+
+:::note
+The schema `id` field must be unique. If you're pasting pipeline schema contents from an existing pipeline schema file, ensure you update the `id` field to a unique value.


removal of the id is also a valid fix.

justinegeffen · 2026-02-18T16:07:42Z

platform-cloud/docs/pipeline-schema/overview.md

+
+Users with [Maintain or higher](../orgs-and-teams/roles.md) permissions can upload a custom `nextflow_schema.json` file directly to Seqera Platform. When you upload a Platform schema:
+
+- The schema content is validated to ensure it's a valid JSON schema


This list, the one below, and the next two should have fullstops at the end of the items. Thanks!

llewellyn-sl and others added 5 commits December 12, 2025 13:18

Pipeline versioning public preview

fe4beca

Exclude API docs from build so deploy preview can succeed

bdb7d33

Merge branch 'master' into plat-4015-custom-schema-docs-update

cab3c65

Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>

llewellyn-sl requested a review from swingingsimian February 17, 2026 13:11

llewellyn-sl and others added 3 commits February 18, 2026 13:17

Update netlify.toml

381cf85

Update netlify.toml

36c3ac4

Add resource labels to versioning exclusion list

9d34edc

Updates versioning documentation to clarify that resource labels are excluded from triggering new pipeline versions, alongside name, image, description, and labels. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

swingingsimian reviewed Feb 18, 2026

View reviewed changes

justinegeffen reviewed Feb 18, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move custom schema documentation to pipeline-schema overview#1139

Move custom schema documentation to pipeline-schema overview#1139
llewellyn-sl wants to merge 9 commits intomasterfrom
plat-4015-custom-schema-docs-update

llewellyn-sl commented Feb 17, 2026

Uh oh!

netlify bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

llewellyn-sl commented Feb 17, 2026

Uh oh!

claude bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

llewellyn-sl commented Feb 17, 2026

Uh oh!

claude bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

swingingsimian Feb 18, 2026

Uh oh!

swingingsimian Feb 18, 2026 •

edited

Loading

Uh oh!

swingingsimian Feb 18, 2026

Uh oh!

swingingsimian Feb 18, 2026

Uh oh!

justinegeffen Feb 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments


		Seqera maintains a history of all draft and published versions, providing an audit trail of pipeline evolution.

		#### Custom schema


		Users with [Maintain or higher](../orgs-and-teams/roles.md) permissions can upload a custom `nextflow_schema.json` file directly to Seqera Platform. When you upload a Platform schema:

		- The schema content is validated to ensure it's a valid JSON schema

Conversation

llewellyn-sl commented Feb 17, 2026

Summary

Test plan

Uh oh!

netlify bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for seqera-docs ready!

Uh oh!

llewellyn-sl commented Feb 17, 2026

Uh oh!

claude bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewing PR: Move custom schema documentation

Review Summary

✅ Positive Changes

🔍 Minor Issues Found

📝 Documentation Quality

🔗 Cross-References Status

Overall Assessment

Uh oh!

llewellyn-sl commented Feb 17, 2026

Uh oh!

claude bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Re-reviewing PR after conflict resolution

✅ Issues Resolved

✅ Continued Strengths

🔍 Current State Analysis

Final Assessment

Uh oh!

swingingsimian Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

swingingsimian Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swingingsimian Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

swingingsimian Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

justinegeffen Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

netlify bot commented Feb 17, 2026 •

edited

Loading

claude bot commented Feb 17, 2026 •

edited

Loading

claude bot commented Feb 17, 2026 •

edited

Loading

swingingsimian Feb 18, 2026 •

edited

Loading