From 7b83e91c4c4bf63a008c8e4c2ec16b6b7c14ccf1 Mon Sep 17 00:00:00 2001 From: Christopher Chianelli Date: Tue, 4 Jun 2024 13:12:26 -0400 Subject: [PATCH] docs: update links to use new quickstart structure (#865) --- docs/src/modules/ROOT/pages/_attributes.adoc | 8 ++++---- .../quickstart/hello-world/hello-world-quickstart.adoc | 2 +- .../quarkus-vehicle-routing-quickstart.adoc | 2 +- .../ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc | 2 +- .../quickstart/spring-boot/spring-boot-quickstart.adoc | 2 +- .../upgrade-and-migration/upgrade-to-latest-version.adoc | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/src/modules/ROOT/pages/_attributes.adoc b/docs/src/modules/ROOT/pages/_attributes.adoc index 76da20595c..51f10c07fb 100644 --- a/docs/src/modules/ROOT/pages/_attributes.adoc +++ b/docs/src/modules/ROOT/pages/_attributes.adoc @@ -1,7 +1,7 @@ // Attributes derived from the maven build, typically versions, are defined in the pom.xml and antora-template.yml. :quickstarts-clone-url: https://github.com/TimefoldAI/timefold-quickstarts :quickstarts-archive-url: https://github.com/TimefoldAI/timefold-quickstarts/archive/refs/heads/stable.tar.gz -:hello-world-java-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/hello-world -:spring-boot-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/technology/java-spring-boot -:quarkus-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/use-cases/school-timetabling -:vrp-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/use-cases/vehicle-routing +:hello-world-java-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/java/hello-world +:spring-boot-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/java/spring-boot-integration +:quarkus-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/java/school-timetabling +:vrp-quickstart-url: https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/java/vehicle-routing diff --git a/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc b/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc index 2e18aed4f5..01adf5495a 100644 --- a/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc +++ b/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc @@ -68,7 +68,7 @@ $ git clone {quickstarts-clone-url} + .. Download an {quickstarts-archive-url}[archive]. -. Find the solution in {hello-world-java-quickstart-url}[the `hello-world` directory]. +. Find the solution in {hello-world-java-quickstart-url}[the `java` directory]. . Follow the instructions in the README file to run the application. == Prerequisites diff --git a/docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc b/docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc index b00174e3ba..14360be69e 100644 --- a/docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc +++ b/docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc @@ -48,7 +48,7 @@ $ git clone {quickstarts-clone-url} + or download an {quickstarts-archive-url}[archive]. -. Find the solution in {vrp-quickstart-url}[the `use-cases` directory] +. Find the solution in {vrp-quickstart-url}[the `java` directory] and run it (see its README file). == Prerequisites diff --git a/docs/src/modules/ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc b/docs/src/modules/ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc index e3a1c1e963..c779ed3c35 100644 --- a/docs/src/modules/ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc +++ b/docs/src/modules/ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc @@ -51,7 +51,7 @@ $ git clone {quickstarts-clone-url} + or download an {quickstarts-archive-url}[archive]. -. Find the solution in {quarkus-quickstart-url}[the `use-cases` directory] +. Find the solution in {quarkus-quickstart-url}[the `java` directory] and run it (see its README file). == Prerequisites diff --git a/docs/src/modules/ROOT/pages/quickstart/spring-boot/spring-boot-quickstart.adoc b/docs/src/modules/ROOT/pages/quickstart/spring-boot/spring-boot-quickstart.adoc index e451395711..f573499803 100644 --- a/docs/src/modules/ROOT/pages/quickstart/spring-boot/spring-boot-quickstart.adoc +++ b/docs/src/modules/ROOT/pages/quickstart/spring-boot/spring-boot-quickstart.adoc @@ -50,7 +50,7 @@ $ git clone {quickstarts-clone-url} + or download an {quickstarts-archive-url}[archive]. -. Find the solution in {spring-boot-quickstart-url}[the `technology` directory] +. Find the solution in {spring-boot-quickstart-url}[the `java` directory] and run it (see its README file). == Prerequisites diff --git a/docs/src/modules/ROOT/pages/upgrade-and-migration/upgrade-to-latest-version.adoc b/docs/src/modules/ROOT/pages/upgrade-and-migration/upgrade-to-latest-version.adoc index c97dd4df45..9a5c311e18 100644 --- a/docs/src/modules/ROOT/pages/upgrade-and-migration/upgrade-to-latest-version.adoc +++ b/docs/src/modules/ROOT/pages/upgrade-and-migration/upgrade-to-latest-version.adoc @@ -256,7 +256,7 @@ None of these changes are likely to affect you, unless you have chosen to depend .icon:exclamation-triangle[role=red] Constraint Verifier: Check your tests if you use the planning list variable [%collapsible%open] ==== -In some cases, especially if you've reused our https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/use-cases/food-packaging[Food Packaging quickstart], you may see your tests failing after the upgrade. +In some cases, especially if you've reused our https://github.com/TimefoldAI/timefold-quickstarts/tree/stable/java/food-packaging[Food Packaging quickstart], you may see your tests failing after the upgrade. This is due to a bug fix in xref:constraints-and-score/score-calculation.adoc#constraintStreams[Constraint Streams], which now currently handles values not present in any list variable. If your code has a shadow entity whose xref:using-timefold-solver/modeling-planning-problems.adoc#listVariableShadowVariablesInverseRelation[inverse relation shadow variable] is a planning list variable and your test leaves that reference `null`, the constraints will no longer take that shadow entity into account.