Whirr
  1. Whirr
  2. WHIRR-116

Site should have docs for each released version

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.2.0
    • Fix Version/s: 0.7.0
    • Component/s: documentation
    • Labels:
      None

      Description

      When we make the second release the website needs to be updated to include documentation for the current release and old releases.

      1. WHIRR-116-site.patch
        30 kB
        Tom White
      2. WHIRR-116.patch
        23 kB
        Tom White
      3. WHIRR-116.patch
        24 kB
        Tom White

        Activity

        Hide
        Tom White added a comment -

        I've just committed this to trunk and the 0.6 branch.

        The website changes should go live soon. Please report any problems you see with the new pages.

        Show
        Tom White added a comment - I've just committed this to trunk and the 0.6 branch. The website changes should go live soon. Please report any problems you see with the new pages.
        Hide
        Tom White added a comment -

        Andrei pointed out that the Project Information links should be absolute. This patch fixes that.

        I'm going to deploy the new site now. We can make more changes as needed.

        Show
        Tom White added a comment - Andrei pointed out that the Project Information links should be absolute. This patch fixes that. I'm going to deploy the new site now. We can make more changes as needed.
        Hide
        Andrei Savu added a comment -

        +1 Looks great! I like the new site structure.

        Show
        Andrei Savu added a comment - +1 Looks great! I like the new site structure.
        Hide
        Tom White added a comment -

        I've split the documentation into two pieces: a site-specific piece and a release-specific piece.

        The site-specific piece (WHIRR-116-site.patch) would live at http://svn.apache.org/repos/asf/whirr/site (i.e. outside trunk) and includes general information about the project, such as a list of people working on it. It would get deployed to http://whirr.apache.org/ whenever we want to change the site (e.g. we could have a news page).

        The release-specific piece (WHIRR-116.patch) lives in where the current docs do (http://svn.apache.org/repos/asf/whirr/trunk). It would get deployed to http://whirr.apache.org/docs/$

        {version}

        on each release.

        I've deployed a copy of these changes to http://people.apache.org/~tomwhite/whirr.apache.org/ so you can see what it looks like. (Note a few images are broken.)

        I haven't added documentation for older versions yet, but we can do that later if we want to.

        I'd like to commit and deploy this soon. When this is live I will change the old incubator site to redirect to the new one.

        Show
        Tom White added a comment - I've split the documentation into two pieces: a site-specific piece and a release-specific piece. The site-specific piece ( WHIRR-116 -site.patch) would live at http://svn.apache.org/repos/asf/whirr/site (i.e. outside trunk) and includes general information about the project, such as a list of people working on it. It would get deployed to http://whirr.apache.org/ whenever we want to change the site (e.g. we could have a news page). The release-specific piece ( WHIRR-116 .patch) lives in where the current docs do ( http://svn.apache.org/repos/asf/whirr/trunk ). It would get deployed to http://whirr.apache.org/docs/$ {version} on each release. I've deployed a copy of these changes to http://people.apache.org/~tomwhite/whirr.apache.org/ so you can see what it looks like. (Note a few images are broken.) I haven't added documentation for older versions yet, but we can do that later if we want to. I'd like to commit and deploy this soon. When this is live I will change the old incubator site to redirect to the new one.
        Hide
        Tom White added a comment -

        I'm going to look at this and fix mailing lists, etc, at the same time.

        Show
        Tom White added a comment - I'm going to look at this and fix mailing lists, etc, at the same time.
        Hide
        Andrei Savu added a comment -

        I believe it's important to address this as a top level project.

        Show
        Andrei Savu added a comment - I believe it's important to address this as a top level project.
        Hide
        Tom White added a comment -

        I just realized that the docs are only available in source form until WHIRR-115 is done. So perhaps we do need this for the release.

        Show
        Tom White added a comment - I just realized that the docs are only available in source form until WHIRR-115 is done. So perhaps we do need this for the release.
        Hide
        Tom White added a comment -

        True, not necessarily a blocker.

        Show
        Tom White added a comment - True, not necessarily a blocker.
        Hide
        Patrick Hunt added a comment -

        I do notice that it's
        http://incubator.apache.org/whirr/quick-start-guide.html
        rather than say whirr/docs/current/... which would facilitate having multiple versions under docs with current being a symbolic link to the most recent stable release docs.

        given the docs are included in the release itself perhaps we can live with this a bit longer? (not a blocker for 0.2.0 I mean). We can go back retroactively and fix.

        Show
        Patrick Hunt added a comment - I do notice that it's http://incubator.apache.org/whirr/quick-start-guide.html rather than say whirr/docs/current/... which would facilitate having multiple versions under docs with current being a symbolic link to the most recent stable release docs. given the docs are included in the release itself perhaps we can live with this a bit longer? (not a blocker for 0.2.0 I mean). We can go back retroactively and fix.

          People

          • Assignee:
            Tom White
            Reporter:
            Tom White
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development