Difference between revisions of "MPICH Website"

From Mpich
Jump to: navigation, search
Line 1: Line 1:
 
This page contains instructions for working on the mpich2 website.
 
This page contains instructions for working on the mpich2 website.
  
The live source for the website can be found at <code>/nfs/web/www.mcs.anl.gov/content/research/projects/mpich2</code>.  This directory is an SVN working copy that is used  as a poor-man's deployment mechanism. The process is to commit changes to the SVN repository and then <code>svn update</code> the above directory.
+
The live source for the website can be found at <code>/nfs/web/www.mcs.anl.gov/content/research/projects/mpich2</code>.  This directory is an SVN working copy that is used  as a poor-man's deployment mechanism. A few things to note:
 
+
# '''NO MANUAL EDITS''' should be done on this main working copy. The process is to commit changes to the SVN repository separately from a different location and then run the <code>update</code> script present in <code>/nfs/web/www.mcs.anl.gov/content/research/projects/mpich2</code>.
The source for the site can be found [https://svn.mcs.anl.gov/repos/mpi/www in SVN]. It consists largely of a straightforward set of PHP files. When making changes, you have three options (they are very similar):
+
# The source for the site can be found [https://svn.mcs.anl.gov/repos/mpi/www in SVN]. It consists largely of a straightforward set of PHP files. When making changes, pull down a working copy of the repository with <code><nowiki>svn checkout https://svn.mcs.anl.gov/repos/mpi/www www</nowiki></code>. You will need SVN credentials under the current setup.
# Pull down a working copy of the repository to your local machine with <code><nowiki>svn checkout https://svn.mcs.anl.gov/repos/mpi/www www</nowiki></code>. Note that you will need SVN credentials under the current setup.  The downside to this approach is that you can't see the effect of your changes as you make them without jumping through some hoops to setup a webserver on your local machine.
+
# You can use <code>/nfs/web/www.mcs.anl.gov/content/research/projects/mpich2staging/$USER</code> as a working copy if you wish to view your changes before committing them in (preferred).
# Do the same as above but put the working copy in <code>/nfs/web/www.mcs.anl.gov/content/research/projects/mpich2$USER</code> (let's call this <code>$ROOT</code>).  Then edit <code>$ROOT/inc/root.php</code> and change part of the URL that says <code>mpich2</code> to whatever your directory you put your working copy in.
+
# Note that if you want to change the structure of the site (menus, some intra-site links, etc), you'll need to update several places.  There are links inside of some pages, on the navbar at the top, and on the subnav on the left.  These all live in separate PHP files, so take care when updating this type of link.
# Use the existing <code>mpich2staging</code> directory (or preferably a sub-directory within mpich2staging) that is a peer to the <code>mpich2</code> directory that is the actual live site. This is just a setup version of #2 above.
 
 
 
No manual edits should be done on the main mpich2 website, only <code>svn update</code> so that you can check everything is working as expected before running the same command on the live site.
 
 
 
Note that if you want to change the structure of the site (menus, some intra-site links, etc), you'll need to update several places.  There are links inside of some pages, on the navbar at the top, and on the subnav on the left.  These all live in separate PHP files, so take care when updating this type of link.
 
  
 
Finding broken links can be done in an easy and automated fashion with any number of tools.  I ([email protected]) have used <code>[http://world.std.com/~swmcd/steven/perl/pm/lc/linkcheck.html linkcheck]</code> with good success.  Once we have the site cleaned up, we should probably run this nightly and have it send us a report if we break anything.
 
Finding broken links can be done in an easy and automated fashion with any number of tools.  I ([email protected]) have used <code>[http://world.std.com/~swmcd/steven/perl/pm/lc/linkcheck.html linkcheck]</code> with good success.  Once we have the site cleaned up, we should probably run this nightly and have it send us a report if we break anything.

Revision as of 21:16, 10 August 2009

This page contains instructions for working on the mpich2 website.

The live source for the website can be found at /nfs/web/www.mcs.anl.gov/content/research/projects/mpich2. This directory is an SVN working copy that is used as a poor-man's deployment mechanism. A few things to note:

  1. NO MANUAL EDITS should be done on this main working copy. The process is to commit changes to the SVN repository separately from a different location and then run the update script present in /nfs/web/www.mcs.anl.gov/content/research/projects/mpich2.
  2. The source for the site can be found in SVN. It consists largely of a straightforward set of PHP files. When making changes, pull down a working copy of the repository with svn checkout https://svn.mcs.anl.gov/repos/mpi/www www. You will need SVN credentials under the current setup.
  3. You can use /nfs/web/www.mcs.anl.gov/content/research/projects/mpich2staging/$USER as a working copy if you wish to view your changes before committing them in (preferred).
  4. Note that if you want to change the structure of the site (menus, some intra-site links, etc), you'll need to update several places. There are links inside of some pages, on the navbar at the top, and on the subnav on the left. These all live in separate PHP files, so take care when updating this type of link.

Finding broken links can be done in an easy and automated fashion with any number of tools. I ([email protected]) have used linkcheck with good success. Once we have the site cleaned up, we should probably run this nightly and have it send us a report if we break anything.