Uploaded image for project: 'MyFaces Core'
  1. MyFaces Core
  2. MYFACES-1288

Document dependencies better

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Won't Fix
    • None
    • None
    • website
    • None

    Description

      We need to document dependencies better.

      For example, http://myfaces.apache.org/impl/dependencies.html shows dependences that are only needed for testing or compiling rather than dependencies needed for running, which is what the end-user cares about.

      http://myfaces.apache.org/gettingstarted.html is frequently out of date as it is manually maintained.

      It seems like the two above could be merged and automatically maintained by maven since maven should be tracking such dependency information already.

      Furthermore, dependencies that only affect a certain component (and this is more of a tomahawk issue) should be identified as such. In fact, the component template (and existing docs) should be updated to include a "dependencies" section. For instance, certain validators depend on commons-validator.jar, and commons-fileupload-1.0.jar is required to use t:inputFileUpload.

      Attachments

        Activity

          People

            Unassigned Unassigned
            mkienenb Mike Kienenberger
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: