Pluto
  1. Pluto
  2. PLUTO-548

Move portlet apis to own svn location

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0.0
    • Fix Version/s: 2.0.0
    • Component/s: general
    • Labels:
      None

      Description

      As discussed in the mailing list and suggested by Ate:

      My suggestion is to create a /portals/portlet-spec svn folder.
      Underneath that, we then could have:
      /portlet-api-1.0/
      /portlet-api-2.0/
      /src/site/
      /pom.xml

      The portlet-api-1.0/src/main/java folder should be a svn copy from:
      /portals/pluto/tags/import/src/api

      The portlet-api-2.0/src/main/java folder should be a svn move from:
      /portals/pluto/trunk/portlet2-api/src/main/java

      The /src/site/resources/javadoc/portlet-api-1.0/ folder should be a svn move from:
      /portals/pluto/trunk/src/site/resources/portlet-1.0-apidocs/

      The /src/site/resources/javadoc/portlet-api-2.0/ folder should be a svn move from:
      /portals/pluto/trunk/src/site/resources/portlet-2.0-apidocs/

      And of course, for all the above new appropriate maven 2 build configurations will need to be setup.
      Oh, one more and very important point: the maven pom.xml for the portlet-api source modules of course needs to be setup independent of the portals pom and use groupid "javax.portlet" (same as we currently have for the portlet2-api module under pluto/trunk).

      This way, we can publish the portlet-api javadocs through:

      http://portals.apache.org/porlet-spec/portlet-api-1.0/
      http://portals.apache.org/porlet-spec/portlet-api-2.0/

      and of course provide a general overview page (possibly with further pointers and info) at:

      http://portals.apache.org/portlet-spec/

      I think that would be very helpful.

      Finding the right portlet api javadoc online always has been "messy", and using the above would finally give them a very clear and easy to remember "home".

      One more thing with regard to the api source: Its obvious we cannot do "releases" of these as they are JCP spec bound.
      So, IMO there is no need for using /trunk, /tags, etc. svn sub folders for them.

        Activity

        Hide
        Carsten Ziegeler added a comment -

        I've created the folder in svn and copied/moved the api's there.
        We didn't store the javadocs in svn so far (at least I didn't find them at src/site/resources).

        As I have no idea how to setup the portals website to include these new stuff, I'm reassigning this issue.

        Show
        Carsten Ziegeler added a comment - I've created the folder in svn and copied/moved the api's there. We didn't store the javadocs in svn so far (at least I didn't find them at src/site/resources). As I have no idea how to setup the portals website to include these new stuff, I'm reassigning this issue.
        Hide
        Ate Douma added a comment -

        Carsten,

        The javadocs are stored in svn, under src/site/resources/javadoc (see also my proposal as you copied in the description of this issue).

        Show
        Ate Douma added a comment - Carsten, The javadocs are stored in svn, under src/site/resources/javadoc (see also my proposal as you copied in the description of this issue).
        Hide
        Ate Douma added a comment -

        Hmm, too fast a response

        I just checked and they are under src/site/resources, but their real location is:

        src/site/resources/portlet-1.0-apidocs
        src/site/resources/portlet-2.0-apidocs

        Show
        Ate Douma added a comment - Hmm, too fast a response I just checked and they are under src/site/resources, but their real location is: src/site/resources/portlet-1.0-apidocs src/site/resources/portlet-2.0-apidocs
        Hide
        Carsten Ziegeler added a comment -

        Hi Ate, yes there they are...hmpf...didn't see them when I looked in the afternoon. Thanks, so I'll continue with this issue in the next days.

        Show
        Carsten Ziegeler added a comment - Hi Ate, yes there they are...hmpf...didn't see them when I looked in the afternoon. Thanks, so I'll continue with this issue in the next days.
        Hide
        Ate Douma added a comment -

        The move of the portlet apis to /portals/portlet_spec has been done.
        Additional steps are now handled through issue PORTALS-14.

        Show
        Ate Douma added a comment - The move of the portlet apis to /portals/portlet_spec has been done. Additional steps are now handled through issue PORTALS-14 .

          People

          • Assignee:
            Unassigned
            Reporter:
            Carsten Ziegeler
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development