Skip to content

docs: introduce docs on how to deploy to the platform, and help page for the licensing tool#2479

Open
oemebamo wants to merge 37 commits into
TimefoldAI:mainfrom
oemebamo:timefold-solver-enterprise-issues-753
Open

docs: introduce docs on how to deploy to the platform, and help page for the licensing tool#2479
oemebamo wants to merge 37 commits into
TimefoldAI:mainfrom
oemebamo:timefold-solver-enterprise-issues-753

Conversation

@oemebamo

@oemebamo oemebamo commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

oemebamo added 29 commits July 6, 2026 20:47
…imefold-solver-enterprise-issues-738-feedback-lee
@oemebamo oemebamo requested a review from TomCools as a code owner July 8, 2026 13:01
oemebamo and others added 3 commits July 9, 2026 09:50
Co-authored-by: Jenne De Bleser <jennedebleser@users.noreply.github.com>
…-757

docs: update maven plugin readme to add in executions & "deploy to platform" docs
@sonarqubecloud

Copy link
Copy Markdown

@larsbeck

larsbeck commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review

Docs-only PR — reads well and content feels accurate. Main issues are cross-doc inconsistencies in copy-paste code examples. No blockers, but a few worth fixing before merge.

Likely bugs / inconsistencies

1. Contradicting score types for the same Timetable example (high)

  • constraint-overrides.adoc: ConstraintWeightOverrides<HardMediumSoftScore> + HardMediumSoftScore.ofHard/ofSoft
  • rest-api.adoc: TimetableConvertor implements ModelConvertor<HardSoftScore, ...>

Same School Timetabling model, two different score types. HardMediumSoftScore is used but there's no .ofMedium anywhere, so it looks like it should be HardSoftScore (matching rest-api and the service quickstart). One of these is wrong.

--> @oemebamo It should be HardMediumSoftScore to keep it consistent.

2. Config property prefix mismatch (model-metadata.adoc, medium)

  • identity: timefold.application.description, timefold.model.maturity-level
  • default profile: ai.timefold.model.default-config.*

The ai. prefix on default-config vs plain timefold. on the others is suspicious. Worth double-checking one isn't a typo — mismatched prefixes silently fail to bind.

--> @oemebamo These properties are actually correct, but they do indeed look inconsisent. I don't see why they should be, so this could be a ticket.

Minor / style

  • demo-data.adoc: the inserted ModelRequest two-constructor paragraph feels topically misplaced on the demo-data page; it reads more like rest-api.adoc material.
  • URL inconsistency: getting-started says platformUrl is typically https://app.timefold.ai; README example uses https://api.timefold.example. Expected placeholder, but worth aligning.
  • .pem claim (license-management.adoc): confirm the license download extension is actually .pem.

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.

2 participants