UIMA
  1. UIMA
  2. UIMA-998

The UIMA website should have a list of known problems and any work-arounds

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.3AS
    • Component/s: Async Scaleout
    • Labels:
      None

      Description

      The list of known problems in the shipped README is rather brief, and is soon out-of-date. It would be nice to have a page on the website listing known problems and any work-arounds.

        Activity

        Hide
        Thilo Goetz added a comment -

        The list is of know problems is in the FAQ: http://incubator.apache.org/uima/faq.html#KnownIssues. If there are things missing, please propose a patch.

        Show
        Thilo Goetz added a comment - The list is of know problems is in the FAQ: http://incubator.apache.org/uima/faq.html#KnownIssues . If there are things missing, please propose a patch.
        Hide
        Burn Lewis added a comment -

        That's nice to see. But soon we'll have UIMA-AS with an additional set of problems. Should we separate them by component in the FAQ?

        Looking at the list of open issues I see 2 that I think belong to UIMA (852,854) and at least 5 for UIMA-AS (845,848,914,955,959) of which 2 are in the current README. Some may have been fixed and maybe not all should be documented. We could add more to the README and copy them to the FAQ when UIMA-AS is released. Or should we just (or also) add a link to the FAQ in the README?

        Show
        Burn Lewis added a comment - That's nice to see. But soon we'll have UIMA-AS with an additional set of problems. Should we separate them by component in the FAQ? Looking at the list of open issues I see 2 that I think belong to UIMA (852,854) and at least 5 for UIMA-AS (845,848,914,955,959) of which 2 are in the current README. Some may have been fixed and maybe not all should be documented. We could add more to the README and copy them to the FAQ when UIMA-AS is released. Or should we just (or also) add a link to the FAQ in the README?
        Hide
        Thilo Goetz added a comment -

        I think we should distinguish between known issues that are going to remain issues, and those that we plan to fix. The "know issues" section in the FAQ only contains things that we know about but can't or won't fix. Things that we intend to fix have jira issues, and that's enough documentation as far as I'm concerned. We don't want to put open issues in that sense on the web page, we just have to remember to remove them when they're fixed.

        Show
        Thilo Goetz added a comment - I think we should distinguish between known issues that are going to remain issues, and those that we plan to fix. The "know issues" section in the FAQ only contains things that we know about but can't or won't fix. Things that we intend to fix have jira issues, and that's enough documentation as far as I'm concerned. We don't want to put open issues in that sense on the web page, we just have to remember to remove them when they're fixed.
        Hide
        Burn Lewis added a comment -

        OK - I think I get it ... no point in documenting something twice ... known problems should be in Jira with the FAQ reserved for problems we can't fix (presumably because they're bugs outside UIMA.) Perhaps we might call these "Limitations" or "Restrictions" and keep the word "issue" for the Jira ones. Even the "won't fix" ones are problematic ... perhaps they may get fixed one day ... e.g. somebody might tackle the Jcasgen merge one in the FAQ.

        Perhaps we could expose this distinction by adding a line to the FAQ and shipped readmes saying that "Known problems and any workarounds have been entered as Jira isues."

        Show
        Burn Lewis added a comment - OK - I think I get it ... no point in documenting something twice ... known problems should be in Jira with the FAQ reserved for problems we can't fix (presumably because they're bugs outside UIMA.) Perhaps we might call these "Limitations" or "Restrictions" and keep the word "issue" for the Jira ones. Even the "won't fix" ones are problematic ... perhaps they may get fixed one day ... e.g. somebody might tackle the Jcasgen merge one in the FAQ. Perhaps we could expose this distinction by adding a line to the FAQ and shipped readmes saying that "Known problems and any workarounds have been entered as Jira isues."
        Hide
        Eddie Epstein added a comment -

        The README in UIMA AS was changed to refer to Jira for known issues with a release.

        Show
        Eddie Epstein added a comment - The README in UIMA AS was changed to refer to Jira for known issues with a release.

          People

          • Assignee:
            Unassigned
            Reporter:
            Burn Lewis
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development