Uploaded image for project: 'OptaPlanner'
  1. OptaPlanner
  2. PLANNER-2525

Change the docs directory structure to comply with Antora

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 8.12.0.Final
    • None
    • Documentation
    • None

      Move the content under optaplanner-docs/src/main/asciidoc to optaplanner-docs/src/main/modules and split documents and images into separate folders. The resulting directory structure should look like as follows:

      modules
      |__ROOT
           |__images
           |    |__BenchmarkingAndTweaking/*.png
           |    |__ ...
           |__pages
                |__BenchmarkingAndTweaking/*.adoc
      

      This structure also requires updating links to images and documents, e.g.:
      image::BenchmarkingAndTweaking/benchmarkOverview.png
      xref::ConstraintStreams/ConstraintStreams-chapter.adoc#constraintStreams[Constraint Streams]

      Make sure all links to images and documents still work (the tooling won't fail fast if they don't).

            rsynek@redhat.com Radovan Synek
            rsynek@redhat.com Radovan Synek
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: