Static Page Protocol: Difference between revisions

From Genecats
Jump to navigationJump to search
(→‎Files for Internal Use: reformatted to match other sections)
(→‎Files Destined for the Round Robin and Mirrors (Public Documents): added note about using FIND=find, noted in redmine #8410)
Line 10: Line 10:
#:<tt>chmod +x fileName</tt>
#:<tt>chmod +x fileName</tt>
#:This will need to be done before you do any makes or you will have to delete the rsync'd file, change the permissions, check them in, and redo the make.
#:This will need to be done before you do any makes or you will have to delete the rsync'd file, change the permissions, check them in, and redo the make.
#(optional) to view your changes on in your own sandbox, on hgwdev type: '''make''' from $HOME/kent/src/hg/htdocs/
#(optional) to view your changes on in your own sandbox, on hgwdev type: '''make user''' from $HOME/kent/src/hg/htdocs/.  If you have created a new file and you want to see it in your own sandbox before committing it to the tree, instead type '''make user FIND=find'''.  (Note that this will copy any files present in your $HOME/kent/src/hg/htdocs/ directory to your /usr/local/apache/htdocs-user/ directory, even if they are not checked in to git.)
#To view your changes on http://hgwdev.cse.ucsc.edu/, on hgwdev type: '''make alpha''' from $HOME/kent/src/hg/htdocs/
#To view your changes on http://hgwdev.cse.ucsc.edu/, on hgwdev type: '''make alpha''' from $HOME/kent/src/hg/htdocs/
#If your changes look good, check them in.
#If your changes look good, check them in.

Revision as of 03:02, 26 July 2012


Files Destined for the Round Robin and Mirrors (Public Documents)

  • These files should only be edited in your checkout of the git kent source tree at $HOME/kent/src/hg/htdocs/
  • After a make, copies will be located in /usr/local/apache/htdocs/ (this is the path used in push requests)
  • Make Procedure:
  1. Note: If your page is new and has a server side include (SSI) which looks something like this:
    <!--#include virtual="../../inc/topbar.html"-->
    make sure the execute bit is turned on for the file which can be done by doing this:
    chmod +x fileName
    This will need to be done before you do any makes or you will have to delete the rsync'd file, change the permissions, check them in, and redo the make.
  2. (optional) to view your changes on in your own sandbox, on hgwdev type: make user from $HOME/kent/src/hg/htdocs/. If you have created a new file and you want to see it in your own sandbox before committing it to the tree, instead type make user FIND=find. (Note that this will copy any files present in your $HOME/kent/src/hg/htdocs/ directory to your /usr/local/apache/htdocs-user/ directory, even if they are not checked in to git.)
  3. To view your changes on http://hgwdev.cse.ucsc.edu/, on hgwdev type: make alpha from $HOME/kent/src/hg/htdocs/
  4. If your changes look good, check them in.
  5. To see changes on http://hgwbeta.cse.ucsc.edu/ (and to get them in the right place for a push request), on hgwbeta type: make beta from $HOME/kent/src/hg/htdocs/
  6. If your changes are ready to go to the RR, then ask the cluster admins for a push of the file(s) in /usr/local/apache/htdocs/ from hgwbeta -> RR.

Large Files either Destined for the Round Robin or are Linked on Genomewiki (These files were too large to be checked into the main htdocs repository)

  • The types of files that are located here are help file examples, tutorial examples, or files that are linked to from Genomewiki.
  • After a make, files are located in /usr/local/apache/htdocs (this is the path used in push requests)
  • To edit these files, checkout the htdocsExtras repository in your home directory:
git clone yourlogin@hgwdev.cse.ucsc.edu:/data/git/htdocsExtras.git/ htdocsExtras
  • Make Procedure:
  1. (optional) to view your changes on in your own sandbox, on hgwdev type: make from $HOME/htdocsExtras/.
  2. To view your changes on http://hgwdev.cse.ucsc.edu/, on hgwdev type make alpha from $HOME/htdocsExtras/.
  3. If your changes look good, check them in.
  4. To see your changes on http://hgwbeta.cse.ucsc.edu/ (and to stage them for release to the RR), on hgwbeta type make beta in your $HOME/htdocsExtras/ directory.
  5. If your changes are ready to go to the RR, request a push of the file(s) in /usr/local/apache/htdocs from hgwbeta -> RR.

Files Destined for hgdownload

  • These files are located in /usr/local/apache/htdocs-hgdownload/ (this is the path used in push requests).
  • To view them: http://hgdownload-test.cse.ucsc.edu/downloads.html.
  • Most of the data files here are NOT kept in a git repository.
  • To edit non-data static docs (such as downloads.html), checkout the hgdownload repository in your home directory:
git clone yourlogin@hgwdev.cse.ucsc.edu:/data/git/hgdownload.git/ hgdownload
  • Make Procedure:
  1. To view your changes on hgdownload-test (http://hgdownload-test.cse.ucsc.edu/) on type make alpha on hgwdev in $HOME/hgdownload
  2. If the changes look good, check them in.
  3. When ready to move to hgdownload, request a push from /usr/local/apache/htdocs-hgdownload/ on hgwdev -> /usr/local/apache/htdocs/ on the RR. (These files should not appear at all on hgwbeta.)

Files for Internal Use

  • These files are located in /usr/local/apache/htdocs-genecats/.
  • To edit these files, checkout the repository in your home directory:
git clone yourlogin@hgwdev.cse.ucsc.edu:/data/git/genecats.git/ genecats
  1. To view your changes on http://genecats.cse.ucsc.edu/, type make install on hgwdev in $HOME/genecats.
  2. If your changes look good, check them in.
Retrieved from "https://genomewiki.ucsc.edu/genecats/index.php?title=Static_Page_Protocol&oldid=1166"