Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.0.0
    • Fix Version/s: 2.1.0
    • Component/s: Code, Documentation
    • Labels:
      None

      Description

      From Gavin:

      1. There is a logo.jpg in src/site/resources/images - the logo is of Log4J.
      I think it was added early on as an example/placeholder until Log4PHP
      created there own logo. Not a blocker IMHO but should be removed.

      2. The top level file called CHANGELOG has some content, then mentions to
      refer to a file called changes.xml. I found this file in /src/changes.xml.
      It would be nice if the CHANGELOG file pointed to the location of the file.
      Not a blocker.

      3. The DOCS directory included in the distribution is actually the generated
      API DOCS - I was expecting to see User Documentation here instead. I would
      suggest this directory be renamed API_DOCS or similar. Not a blocker.

      4. If you are going to the trouble of generating the API DOCS, why not
      generate the User Documentation too? This is to be aimed at users as well as
      devs and it should be made easy for them. Having them included in the depths
      of the source tree as .apt files gives them a harder route and an extra
      dependency to build the documentation they seek to use. The documentation is
      of course available online. Not a blocker.

        Activity

        Hide
        juice Ivan Habunek added a comment -

        1. log4j logo has been removed, as well as the unused incubation logo
        2. CHANGELOG now points to src/changes/changes.xml and to the online changelog.
        3. Renamed docs folder to apidocs.
        4. Generated docs will not be included for the time being. We will consider this when moving to doxygen (LOG4PHP-135).

        Show
        juice Ivan Habunek added a comment - 1. log4j logo has been removed, as well as the unused incubation logo 2. CHANGELOG now points to src/changes/changes.xml and to the online changelog. 3. Renamed docs folder to apidocs. 4. Generated docs will not be included for the time being. We will consider this when moving to doxygen ( LOG4PHP-135 ).

          People

          • Assignee:
            juice Ivan Habunek
            Reporter:
            cgrobmeier Christian Grobmeier
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development