Details

    • Type: Task
    • Status: Open (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 1.2.0
    • Component/s: documentation
    • Labels:
      None

      Description

      It's expected that all developer oriented aspects will be self documented with javadoc and examples (udfs, pom options, configuration, custom extensions, etc.). However the Teiid ddl, sql - and in particular the presentation of topics that were presented separately such as data roles - need to be covered by documentation that does not reference topics such as Designer, wildfly/cli, xml vdbs, etc. We should probably also discuss if it makes any sense to still offer the local adminapi.

      We expect to receive some input from the documentation group around doc structure and strategies for generating specific documentation sets off of a master. At a high level we have:

      Administrator’s Guide - WildFly specific and should mostly be replaced by examples
      Caching Guide - References adminapi, Teiid JDBC, xml vdbs..
      Client Developer’s Guide - Teiid JDBC
      Developer’s Guide - References WildFly and several arche-types are specific to WildFly/JEE - should mostly be replaced by examples
      Embedded Guide - Should mostly be replaced by examples
      Reference Guide - References XML vdbs
      Security Guide - WildFly specific and should mostly be replaced by examples, but a lot is TDB

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  shawkins Steven Hawkins
                  Reporter:
                  shawkins Steven Hawkins
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated: