Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

We've already moved from Apache CMS to .asf.yaml features provided by ASF Infra for website publishing, so the contents in this page are obsolete. See the following explanation for details about .asf.yaml.
https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-WebSiteDeploymentServiceforGitRepositories

Also, we've automated the publishing process as a Jenkins pipeline and are running it as a daily job. It's temporarily suspended due to BIGTOP-3467 as of Dec 2020, but it will be resumed once the problem is resolved.
https://ci-builds.apache.org/job/BigTop/job/pipeline-site/

Even though Bigtop project manages its own website via Mave's site plugin the deployment still needs to happen by committing to the svnpubsub.

If you want to update Bigtop's website, here's a set of steps you need to go through:

...

  • Open a JIRA ticket under the website component that describes the desired changes.

  • Checkout our official ASF git repo
    $ git clone :

    Code Block
    languagebash
    git clone https://
    git-wip-us
    gitbox.apache.org/repos/asf/bigtop.git


  • Open JIRA ticket for the changes; make the Make the desired changes under ./src/site.
  • Build and test the result

    via

    :

    $ mvn
    Code Block
    languagebash
    mvn site:site

    $
    
    mvn site:run

    $
    
    firefox http://localhost:8080


  • When satisfied, commit back to the official

    Git repo

    git repo:

    Code Block
    git commit -am 'BIGTOP-XXXX. <Your comment>'
    git push


  • The deploy command may fail due to missing subversion credentials. To circumvent that, see here.
    To setup proper credential before deploying the code to SVN, REPLACE oflebbe to your account:

    Code Block
    languagebash
    --- a/pom.xml
    +++ b/pom.xml
    @@ -492,7 +492,7 @@
       <distributionManagement>
         <site>
           <id>apache.website</id>
    -      <url>scm:svn:https://svn.apache.org/repos/infra/websites/staging/bigtop/trunk/content</url>
    +      <url>scm:svn:https://oflebbe@svn.apache.org/repos/infra/websites/staging/bigtop/trunk/content</url>
         </site>
       </distributionManagement>


  • Now it is time to actually publish the website:

    Code Block
    languagebash

...

  • mvn -Dpassword=xxxxxx site-deploy #yes, dash, not a colon


  • This will deploy the generated website to /www/bigtop.apache.org/ on people.apache.org. You can SSH there to check that things look OK.
    • If you do not have SSH access to people.apache.org, you may skip this step and verify your changes in the next step.
  • Once the deployment is done you need to publish the new website via .: login
    •  and click the (warning) "Publish bigtop site" link. Otherwise the content won't get propagated.
    • On the publish page, you will see a "View Diff" link.  Click this to ensure the staged changes are acceptable.
    • If the diff looks OK, add a log message about what changed and click "Submit".
  • It will take an hour or so for the website to become live, but you can inspect the website by temporarily setting your browser proxy to see the new, unmirrored content (I used FoxyProxy in Firefox) as described in http://www.apache.org/dev/project-site.html.