Skip to content

Commit

Permalink
docs: Standardize all includes to leveloffset=+1
Browse files Browse the repository at this point in the history
  • Loading branch information
ge0ffrey committed Mar 20, 2017
1 parent 6575e76 commit 4dc2cfc
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
Expand Up @@ -7,12 +7,12 @@
:experimental:
:sourcedir: .

include::Section-What_is_OptaPlanner.adoc[]
include::Section-What_is_OptaPlanner.adoc[leveloffset=+1]

include::Section-What_is_a_planning_problem.adoc[]
include::Section-What_is_a_planning_problem.adoc[leveloffset=+1]

include::Section-Requirements.adoc[]
include::Section-Requirements.adoc[leveloffset=+1]

include::Section-Governance.adoc[]
include::Section-Governance.adoc[leveloffset=+1]

include::Section-Download_and_run_the_examples.adoc[]
include::Section-Download_and_run_the_examples.adoc[leveloffset=+1]
@@ -1,9 +1,9 @@
[[downloadAndRunTheExamples]]
== Download and Run the Examples
= Download and Run the Examples


[[getTheReleaseZipAndRunTheExamples]]
=== Get the Release .zip and Run the Examples
== Get the Release .zip and Run the Examples

To try it now:

Expand Down Expand Up @@ -43,7 +43,7 @@ It runs just as well on a server or a mobile JVM as it does on the desktop.
====

[discrete]
== Run the Webexamples
= Run the Webexamples

Besides the GUI examples, there are also a set of webexamples to try out. The webexamples include:

Expand Down Expand Up @@ -84,7 +84,7 @@ image::Chapter-Planner_introduction/plannerWebexamplesScreenshot.png[align="cent


[[runTheExamplesInAnIDE]]
=== Run the Examples in an IDE (IntelliJ, Eclipse, NetBeans)
== Run the Examples in an IDE (IntelliJ, Eclipse, NetBeans)

To run the examples in your favorite IDE:

Expand All @@ -105,7 +105,7 @@ To run the examples in your favorite IDE:


[[useWithMavenGradleEtc]]
=== Use OptaPlanner with Maven, Gradle, Ivy, Buildr or ANT
== Use OptaPlanner with Maven, Gradle, Ivy, Buildr or ANT

The OptaPlanner jars are also available in http://search.maven.org/#search|ga|1|org.optaplanner[the central maven repository] (and also in
pass:macros[https://repository.jboss.org/nexus/index.html#nexus-search;gav~org.optaplanner~~~~[the JBoss maven repository\]]).
Expand Down Expand Up @@ -157,7 +157,7 @@ Check the maven repository [path]_pom.xml_


[[buildFromSource]]
=== Build OptaPlanner from Source
== Build OptaPlanner from Source

It's easy to build OptaPlanner from source.

Expand Down
@@ -1,21 +1,21 @@
[[governance]]
== Governance
= Governance


[[statusOfOptaPlanner]]
=== Status of OptaPlanner
== Status of OptaPlanner

OptaPlanner is stable, reliable and scaleable. It has been heavily tested with unit, integration, and stress tests, and is used in production throughout the world. One example handles over 50 000 variables with 5000 variables each, multiple constraint types and billions of possible constraint matches.


[[releaseNotes]]
=== Release Notes
== Release Notes

We release a `Beta` or `CR` version every few weeks and a `Final` version every few months. https://www.optaplanner.org/download/releaseNotes/[Read the release notes of each release on our website.]


[[backwardsCompatibility]]
=== Backwards Compatibility
== Backwards Compatibility

OptaPlanner separates its API and implementation:

Expand All @@ -32,7 +32,7 @@ Those documented `impl` classes are reliable and safe to use (unless explicitly


[[communityAndSupport]]
=== Community and Support
== Community and Support

For news and articles, check https://www.optaplanner.org/blog/[our blog], Google+ (https://plus.google.com/+OptaPlannerOrg[OptaPlanner], https://plus.google.com/+GeoffreyDeSmet[Geoffrey De Smet]) and twitter (https://twitter.com/OptaPlanner[OptaPlanner], https://twitter.com/GeoffreyDeSmet[Geoffrey De Smet]).
*If OptaPlanner helps you, help us by blogging or tweeting about it!*
Expand All @@ -46,11 +46,11 @@ For enterprise support and consulting, take a look at https://www.optaplanner.or


[[relationshipWithKie]]
=== Relationship with Drools and jBPM
== Relationship with Drools and jBPM

OptaPlanner is part of the http://www.kiegroup.org[KIE group of projects].
It releases regularly (often once or twice per month) together with the http://www.drools.org/[Drools] rule engine and the http://www.jbpm.org/[jBPM] workflow engine.

image::Chapter-Planner_introduction/kieFunctionalityOverview.png[align="center"]

See <<architectureOverview,the architecture overview>> to learn more about the optional integration with Drools.
See <<architectureOverview,the architecture overview>> to learn more about the optional integration with Drools.
@@ -1,5 +1,5 @@
[[requirements]]
== Requirements
= Requirements

OptaPlanner is _open source_ software, released under http://www.apache.org/licenses/LICENSE-2.0.html[the Apache Software License 2.0].
This license is very liberal and allows reuse for commercial purposes.
Expand Down
@@ -1,5 +1,5 @@
[[whatIsOptaPlanner]]
== What is OptaPlanner?
= What is OptaPlanner?

Every organization faces planning problems: providing products or services with a limited set of _constrained_ resources (employees, assets, time and money). OptaPlanner optimizes such planning to do more business with less resources.
This is known as _Constraint Satisfaction Programming_ (which is part of the _Operations Research_ discipline).
Expand All @@ -16,4 +16,4 @@ https://www.optaplanner.org[OptaPlanner] is a lightweight, embeddable constraint
* **Sport scheduling**: planning games and training schedules for football leagues, baseball leagues, ...
* **Financial optimization**: investment portfolio optimization, risk spreading, ...

image::Chapter-Planner_introduction/useCaseOverview.png[align="center"]
image::Chapter-Planner_introduction/useCaseOverview.png[align="center"]
@@ -1,5 +1,5 @@
[[whatIsAPlanningProblem]]
== What is a Planning Problem?
= What is a Planning Problem?
image::Chapter-Planner_introduction/whatIsAPlanningProblem.png[align="center"]

A planning problem has an optimal goal, based on limited resources and under specific constraints. Optimal goals can be any number of things, such as:
Expand All @@ -21,7 +21,7 @@ OptaPlanner helps Java^TM^ programmers solve constraint satisfaction problems ef


[[aPlanningProblemIsNPCompleteOrNPHard]]
=== A Planning Problem is NP-complete or NP-hard
== A Planning Problem is NP-complete or NP-hard

All the use cases above are _probably_ http://en.wikipedia.org/wiki/NP-complete[NP-complete] or harder.
In layman's terms, NP-complete means:
Expand All @@ -47,7 +47,7 @@ By using advanced optimization algorithms, *OptaPlanner does find a good solutio


[[aPlanningProblemHasConstraints]]
=== A Planning Problem Has (Hard and Soft) Constraints
== A Planning Problem Has (Hard and Soft) Constraints

Usually, a planning problem has at least two levels of constraints:

Expand All @@ -67,7 +67,7 @@ Such code is easy, flexible and scalable.


[[aPlanningProblemHasAHugeSearchSpace]]
=== A Planning Problem Has a Huge Search Space
== A Planning Problem Has a Huge Search Space

A planning problem has a number of __solutions__.
There are several categories of solutions:
Expand Down

0 comments on commit 4dc2cfc

Please sign in to comment.