Uploaded image for project: 'BxMS Documentation'
  1. BxMS Documentation
  2. BXMSDOC-4615

Edit and modularize OptaPlanner community documentation

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • None
    • 7.9
    • None
    • None
    • Edit OptaPlanner community documentation
    • To Do

      Notes for modularizing from meeting with Geoffrey;
      Already modularized
      Introduction
      QuickStart
      ExamplesAndUseCases

      Action plan (geoffrey)
      TitleCase PR across optaplanner-docs
      New IBM standard
      2 chapters completely peer reviewed
      Design patterns (ongoing)
      Score calculation?
      Update existing modularization
      Ids of Introduction / QuickStart / ExamplesAndUseCases
      Modularize another chapter
      Design patterns

      Open questions
      id

      Action plan for modularization and single sourcing (ccs)
      git subtree
      product-docs-repo
      optaplanner -> optaplanner_repo/optaplanner-docs/src/main/assciidoc

      Action plan for addressing 7.6 bapls in product documents
      -For 7.6, Geoffrey updates the upstream content with BAPL info. Emily takes content from upstream and covers the same in product docs. Please note: Upstream single sourcing effort needs to be prioritized.

      Incoming features that will have docs
      ConstraintStreams (in progress) 7.6
      SolverManager (code in progress, docs coming soon) 7.7
      Spring-boot-starter 7.7
      quarkus-extension 7.7

              emmurphy1@redhat.com Emily Murphy
              emmurphy1@redhat.com Emily Murphy
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: