Details

    • Type: Task Task
    • Status: Resolved
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: build, documentation
    • Labels:
      None

      Description

      To migrate to svnpubsub we need to have the website checked into svn (note that git isn't supported for websites, see http://www.apache.org/dev/project-site.html). Currently it is not checked in, since we just generate the site with mvn and copy it to a directory on people.apache.org. This mechanism will be removed at the end of this month.

        Issue Links

          Activity

          Hide
          Tom White added a comment -

          I suggest we put the site contents under http://svn.apache.org/repos/asf/whirr/site/production. There are two parts to the site - the top-level site generated from http://svn.apache.org/repos/asf/whirr/site/src, and the documents for each release generated from the main project repo at http://svn.apache.org/repos/asf/whirr/trunk. The site generation procedure would change so that the generated files from each part would be copied to a checked out version of http://svn.apache.org/repos/asf/whirr/site/production. To publish, the changes would simply be checked in, which would trigger the svnpubsub process.

          Once we have got the current site in svn we can open an infra ticket https://issues.apache.org/jira/browse/INFRA to ask for the site to be published using svnpubsub (they can't do anything until there's a svn URL, http://www.apache.org/dev/infra-contact#what-we-need-to-know).

          Does that sound good?

          Show
          Tom White added a comment - I suggest we put the site contents under http://svn.apache.org/repos/asf/whirr/site/production . There are two parts to the site - the top-level site generated from http://svn.apache.org/repos/asf/whirr/site/src , and the documents for each release generated from the main project repo at http://svn.apache.org/repos/asf/whirr/trunk . The site generation procedure would change so that the generated files from each part would be copied to a checked out version of http://svn.apache.org/repos/asf/whirr/site/production . To publish, the changes would simply be checked in, which would trigger the svnpubsub process. Once we have got the current site in svn we can open an infra ticket https://issues.apache.org/jira/browse/INFRA to ask for the site to be published using svnpubsub (they can't do anything until there's a svn URL, http://www.apache.org/dev/infra-contact#what-we-need-to-know ). Does that sound good?
          Hide
          Ashish Paliwal added a comment -

          We have one more related JIRA https://issues.apache.org/jira/browse/WHIRR-508

          I would suggest we keep site under trunk, and once things are ready we move to production. From trunk, we can check things on staging.whirr.a.o (once infra sets it up)

          Show
          Ashish Paliwal added a comment - We have one more related JIRA https://issues.apache.org/jira/browse/WHIRR-508 I would suggest we keep site under trunk, and once things are ready we move to production. From trunk, we can check things on staging.whirr.a.o (once infra sets it up)
          Hide
          Tom White added a comment -

          Do we need the site under trunk and under site/production? Seems overkill. After generating the site locally you can test it in a browser then check it in when satisfied. If there are any errors then it's easy to roll back since all the old files are in svn. In fact, this is better than what we have today since we don't have a history of the generated files (just the site source).

          I missed WHIRR-508 earlier, but it's the same issue as this one.

          Show
          Tom White added a comment - Do we need the site under trunk and under site/production? Seems overkill. After generating the site locally you can test it in a browser then check it in when satisfied. If there are any errors then it's easy to roll back since all the old files are in svn. In fact, this is better than what we have today since we don't have a history of the generated files (just the site source). I missed WHIRR-508 earlier, but it's the same issue as this one.
          Hide
          Ashish Paliwal added a comment -

          The only problem would be, we won't be able to checkin half cooked stuff. Not a big issue once the site is up and running. We went through couple of iterations before going to production. And it helped.

          I don't have any hard preferences, anything that makes life simple, is the way

          Show
          Ashish Paliwal added a comment - The only problem would be, we won't be able to checkin half cooked stuff. Not a big issue once the site is up and running. We went through couple of iterations before going to production. And it helped. I don't have any hard preferences, anything that makes life simple, is the way
          Hide
          Ashish Paliwal added a comment -

          @Tom - Do we need the whole site in a single go? Should I generate a patch or just zip it up and attach.

          I shall have something to share in next 2 days. Struggling with CSS

          Show
          Ashish Paliwal added a comment - @Tom - Do we need the whole site in a single go? Should I generate a patch or just zip it up and attach. I shall have something to share in next 2 days. Struggling with CSS
          Hide
          Tom White added a comment -

          Thanks Ashish. Yes, we need the whole site, both the top-level and the current docs. See "Build and deploy documentation" and "Build and Deploy Site" on https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release. It might be easiest for a committer to do these steps then check them into svn for others to review. I'll try to do that in the next day or so.

          Show
          Tom White added a comment - Thanks Ashish. Yes, we need the whole site, both the top-level and the current docs. See "Build and deploy documentation" and "Build and Deploy Site" on https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release . It might be easiest for a committer to do these steps then check them into svn for others to review. I'll try to do that in the next day or so.
          Hide
          Ashish Paliwal added a comment -

          Ok, I shall try to upload a beta version for Top level site by tomorrow.

          What do you mean by current docs? Is it Javadocs?

          Show
          Ashish Paliwal added a comment - Ok, I shall try to upload a beta version for Top level site by tomorrow. What do you mean by current docs? Is it Javadocs?
          Hide
          Ashish Paliwal added a comment -

          Attached is the beta version of website only. Can build and try it locally. It's in trunk, but the content can be placed at any other location. The complete migration to markdown syntax was not done, to maintain the current style.

          Generated documents(like javadoc) need to be uploaded in a different way. Don't have the information handy. Shall figure out the way and update.

          Show
          Ashish Paliwal added a comment - Attached is the beta version of website only. Can build and try it locally. It's in trunk, but the content can be placed at any other location. The complete migration to markdown syntax was not done, to maintain the current style. Generated documents(like javadoc) need to be uploaded in a different way. Don't have the information handy. Shall figure out the way and update.
          Hide
          Tom White added a comment -

          Thanks, Ashish. I don't think we need to convert the website content at this point, just check the current content into svn.

          I just checked in a copy to http://svn.apache.org/repos/asf/whirr/site/production. I generated it by changing the distributionManagement site URL in the top-level pom to

          file:///tmp/whirr.apache.org/docs/${project.version}
          

          and typing mvn site-deploy. Then for the top-level site (in http://svn.apache.org/repos/asf/whirr/site) I changed the site url to file:///tmp/whirr.apache.org and then did a mvn site-deploy.

          This made a local copy of the site which I then copied to my svn checkout and committed. I also pushed a copy to http://people.apache.org/~tomwhite/whirr-staging/. (It looks fine, except for the Whirr logo, but I don't think this is actually a problem when it is deployed to a top-level domain, since the live website has the same URL to the image.)

          If folks think this looks OK, then we can open the INFRA ticket to transfer the site.

          Show
          Tom White added a comment - Thanks, Ashish. I don't think we need to convert the website content at this point, just check the current content into svn. I just checked in a copy to http://svn.apache.org/repos/asf/whirr/site/production . I generated it by changing the distributionManagement site URL in the top-level pom to file:///tmp/whirr.apache.org/docs/${project.version} and typing mvn site-deploy . Then for the top-level site (in http://svn.apache.org/repos/asf/whirr/site ) I changed the site url to file:///tmp/whirr.apache.org and then did a mvn site-deploy . This made a local copy of the site which I then copied to my svn checkout and committed. I also pushed a copy to http://people.apache.org/~tomwhite/whirr-staging/ . (It looks fine, except for the Whirr logo, but I don't think this is actually a problem when it is deployed to a top-level domain, since the live website has the same URL to the image.) If folks think this looks OK, then we can open the INFRA ticket to transfer the site.
          Hide
          Ashish Paliwal added a comment -

          Tom - To the best of my knowledge, it won't work.
          Please see the constraints for adoption http://www.apache.org/dev/cms.html#constraints

          Show
          Ashish Paliwal added a comment - Tom - To the best of my knowledge, it won't work. Please see the constraints for adoption http://www.apache.org/dev/cms.html#constraints
          Hide
          Tom White added a comment -

          No, I think it's fine. I now see where the confusion came about - we don't need to convert the site to use the Apache CMS, rather we just need to switch to using svnpubsub to publish our website from SVN. These are the two distinct options for hosting project websites - see http://www.apache.org/dev/project-site#intro.

          We are still using the existing mechanism for generating the site (Maven site), and the change I made here is merely to put the website into SVN so that infra can then set up svnpubsub for us.

          Does that make sense?

          Show
          Tom White added a comment - No, I think it's fine. I now see where the confusion came about - we don't need to convert the site to use the Apache CMS, rather we just need to switch to using svnpubsub to publish our website from SVN. These are the two distinct options for hosting project websites - see http://www.apache.org/dev/project-site#intro . We are still using the existing mechanism for generating the site (Maven site), and the change I made here is merely to put the website into SVN so that infra can then set up svnpubsub for us. Does that make sense?
          Hide
          Ashish Paliwal added a comment -

          Yeah Got it I was not aware of this option. Lets go ahead and create the Infra ticket.

          I have migrated using the other option, so anytime we need to switch we can.

          Thanks for clarifying.

          Show
          Ashish Paliwal added a comment - Yeah Got it I was not aware of this option. Lets go ahead and create the Infra ticket. I have migrated using the other option, so anytime we need to switch we can. Thanks for clarifying.
          Hide
          Tom White added a comment -

          Thanks Ashish. I created a ticket: INFRA-5672.

          When that's closed we need to update https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release with the instructions on publishing the website.

          Show
          Tom White added a comment - Thanks Ashish. I created a ticket: INFRA-5672 . When that's closed we need to update https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release with the instructions on publishing the website.
          Hide
          Tom White added a comment -

          Gavin fixed INFRA-5672, and I tested the change by updating the front page of the Whirr website. I updated the release docs too.

          Show
          Tom White added a comment - Gavin fixed INFRA-5672 , and I tested the change by updating the front page of the Whirr website. I updated the release docs too.

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development