-
Notifications
You must be signed in to change notification settings - Fork 951
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BXMSDOC-8220 Vaccination Scheduler #1618
Conversation
:OPTAPLANNER-COMM: | ||
//Variable for the community version conditional statements. | ||
//:OPTAPLANNER-ENT: | ||
//Variable for the enterprise version conditional statements. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of these attributes should be defined from the outside (in the POM).
[id="chap-optaplanner-vaccination_{context}"] | ||
= OptaPlanner Vaccination Scheduler | ||
|
||
:OPTAPLANNER-COMM: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Meeting result: we can use ifnotdef for these, so we don't need this one
|
||
:OPTAPLANNER-COMM: | ||
//Variable for the community version conditional statements. | ||
//:OPTAPLANNER-ENT: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's put it in attributes.adoc
Let's rename this to just "productized" (to be in sync with "productized" that productization (marek team) is using to signal it's a product build (and some kie projects have a maven profiles that use that).
If it needs to be namespaced, we can use "optaplanner-productized" instead. But I strongly doubt it should be.
cc @rsynek
|
||
ifdef::OPTAPLANNER-COMM[] | ||
|
||
:imagesdir: ../.. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have/need this attribute any more
:OPTAPLANNER: OptaPlanner | ||
:QUARKUS: Quarkus | ||
:OPTAPLANNER_JDK_VERSION: 11 | ||
:OPTAPLANNER_MAVEN_VERSION: 3.6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these come from the build
The attributes.adoc file should have a comment that these properties come from the build and exist.
Optionally, the attributes.adoc file can default them to "<ERROR - optaplanner-maven-version not set>"
If it's the minimum maven version, then it should contain minimum (or min).
|
||
ifdef::OPTAPLANNER-ENT[] | ||
* You have created a Quakus OptaPlanner project as described in xref:optaplanner-quarkus-con_getting-started-optaplanner[]. | ||
endif::OPTAPLANNER-ENT[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In community this should link to
https://www.optaplanner.org/docs/optaplanner/latest/quickstart/quickstart.html#quarkusJavaQuickStart
@@ -0,0 +1,266 @@ | |||
[id="chap-optaplanner-vaccination_{context}"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the context
attribute needs to be defined at a higher level - in the file that includes this one vaccination-scheduling.adoc
. Otherwise at this point it is undefined and the substitution here doesn't work.
|
||
You can use the {OPTAPLANNER} vaccination appointment scheduler quick start to develop a vaccination schedule that is both efficient and fair. The vaccination appointment scheduler uses artificial intelligence (AI) to prioritize people and allocate time slots based on multiple constraints and priorities. | ||
|
||
.Prerequisites |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd move this prerequisite closer to where it's actually needed, which is the procedure Downloading and running the OptaPlanner vaccination appointment scheduler, so line 151.
@ge0ffrey I removed the single-source elements so if you approve the updated content this PR can be merged. |
3fb6344
to
fcd7d37
Compare
= OptaPlanner Vaccination Scheduler | ||
|
||
|
||
You can use the {optaplanner} vaccination appointment scheduler quick start to develop a vaccination schedule that is both efficient and fair. The vaccination appointment scheduler uses artificial intelligence (AI) to prioritize people and allocate time slots based on multiple constraints and priorities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use the {optaplanner} vaccination appointment scheduler quick start to develop a vaccination schedule that is both efficient and fair. The vaccination appointment scheduler uses artificial intelligence (AI) to prioritize people and allocate time slots based on multiple constraints and priorities. | |
Use the {optaplanner} vaccination appointment scheduler quick start to develop a vaccination schedule that is both efficient and fair. The vaccination appointment scheduler uses artificial intelligence (AI) to prioritize people and allocate time slots based on multiple constraints and priorities. |
:quarkus: Quarkus |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we drop these 2 lines?
:optaplanner: OptaPlanner | ||
:quarkus: Quarkus | ||
:optaplanner-jdk-version: 11 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The java version is already coming in through the maven/antora build IIRC. @yurloc Can you verify (or check with Radovan)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to merge. Some suggestions, no blockers.
@yurloc Can you review (and work with Emily to adjust if desired) and merge?
928a42f
to
7e401df
Compare
7e401df
to
d4485c8
Compare
We are using this PR to figure out all of the components that we need to single-source OptaPlanner content.
Details are in BXMSDOC-8220.
The HTML draft is here.