Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 2.3.0
    • Fix Version/s: 2.3.0
    • Component/s: Documentation
    • Labels:
      None
    • Environment:
      All, web site

      Description

      The overview of mailets is not complete. For example, the FromRepository mailet is missing.

      See http://james.apache.org/provided_mailets_2_1.html and compare with the mailets in the package org.apache.james.transport.mailets

      Thanks,

      Hes.

      1. diff.txt
        4 kB
        Hes Siemelink

        Activity

        Hide
        hes.siemelink Hes Siemelink added a comment -

        It turns out that the documentation has been updated in the CVS branch branch_2_1_fcs.

        However, the site is generated from the MAIN branch using outdated files.

        Proposed fix: copy the contents of src/xdocs from branch_2_1_fcs to MAIN and regenerate the web site.

        Show
        hes.siemelink Hes Siemelink added a comment - It turns out that the documentation has been updated in the CVS branch branch_2_1_fcs. However, the site is generated from the MAIN branch using outdated files. Proposed fix: copy the contents of src/xdocs from branch_2_1_fcs to MAIN and regenerate the web site.
        Hide
        noel Noel J. Bergman added a comment -

        Do NOT copy over the xdocs. They are only partially updated, specifically for the version 2 release. The public site is generated from MAIN, and only that has been maintained.

        Show
        noel Noel J. Bergman added a comment - Do NOT copy over the xdocs. They are only partially updated, specifically for the version 2 release. The public site is generated from MAIN, and only that has been maintained.
        Hide
        hes.siemelink Hes Siemelink added a comment -

        At least the file src/xdocs/provided_mailets_2_1.xml from the branch_2_1_fcs should be published on the web site.

        Show
        hes.siemelink Hes Siemelink added a comment - At least the file src/xdocs/provided_mailets_2_1.xml from the branch_2_1_fcs should be published on the web site.
        Hide
        hes.siemelink Hes Siemelink added a comment -

        Here's the diff that will update provided_mailets_2_1.xml in trunk, so it can be published to the web site.

        Show
        hes.siemelink Hes Siemelink added a comment - Here's the diff that will update provided_mailets_2_1.xml in trunk, so it can be published to the web site.
        Hide
        vincenzo Vincenzo Gianferrari Pini added a comment -

        The documentation in branch_2_1_fcs/src/xdocs/provided_mailets_2_1.xml is not up-to-date (many more mailets and matchers are missing), so first of all it has to be updated before updating the version in trunk.

        Show
        vincenzo Vincenzo Gianferrari Pini added a comment - The documentation in branch_2_1_fcs/src/xdocs/provided_mailets_2_1.xml is not up-to-date (many more mailets and matchers are missing), so first of all it has to be updated before updating the version in trunk.
        Hide
        hes.siemelink Hes Siemelink added a comment -

        A while back I proposed to use xdoclet for mailet/matcher documentation.

        See http://nagoya.apache.org/eyebrowse/ReadMsg?listName=james-user@jakarta.apache.org&msgId=2072253

        I could spend some time on converting the documentation, provided that a committer commits to committing the changes into SVN.

        Show
        hes.siemelink Hes Siemelink added a comment - A while back I proposed to use xdoclet for mailet/matcher documentation. See http://nagoya.apache.org/eyebrowse/ReadMsg?listName=james-user@jakarta.apache.org&msgId=2072253 I could spend some time on converting the documentation, provided that a committer commits to committing the changes into SVN.
        Hide
        norman Norman Maurer added a comment -

        This should fixed before release 2.3.0

        Show
        norman Norman Maurer added a comment - This should fixed before release 2.3.0
        Hide
        norman Norman Maurer added a comment -
        • Fixed in trunk
        • Backported in branch
        • Updated site
        Show
        norman Norman Maurer added a comment - Fixed in trunk Backported in branch Updated site
        Hide
        danny@apache.org Danny Angus added a comment -

        Closing issue fixed in released version.

        Show
        danny@apache.org Danny Angus added a comment - Closing issue fixed in released version.

          People

          • Assignee:
            norman Norman Maurer
            Reporter:
            hes Hes Siemelink
          • Votes:
            2 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development