Difference between revisions of "User talk:Jeshyr"
(Test rewrite of $LJHOME page) |
(Test rewrite of $LJHOME page) |
||
| Line 3: | Line 3: | ||
This documents the contents of the $LJHOME development folder as checked out by <code>bootstrap.pl</code> and present on all Dreamhacks. | This documents the contents of the $LJHOME development folder as checked out by <code>bootstrap.pl</code> and present on all Dreamhacks. | ||
| − | + | = [[Main development folder/bin|bin]] = | |
| − | + | ||
| − | + | ||
This directory contains backend utilities for maintaining and upgrading the site. | This directory contains backend utilities for maintaining and upgrading the site. | ||
| − | + | = [[Main development folder/cgi-bin|cgi-bin]] = | |
This directory contains the code libraries that run the site. This is the base of the library path--that is <code>use Net::OpenID::Consumer;</code> refers to the code in <code>cgi-bin/Net/OpenID/Consumer.pm</code>. It contains all the custom Perl libraries and functions that the code references including the <code>LJ::*</code> and <code>DW::*</code> libraries. Code in <code>*.pl</code> files in this directory are also library files but in an older style ([http://bugs.dwscoalition.org/show_bug.cgi?id=1726 bug 1726] refers to these updates). | This directory contains the code libraries that run the site. This is the base of the library path--that is <code>use Net::OpenID::Consumer;</code> refers to the code in <code>cgi-bin/Net/OpenID/Consumer.pm</code>. It contains all the custom Perl libraries and functions that the code references including the <code>LJ::*</code> and <code>DW::*</code> libraries. Code in <code>*.pl</code> files in this directory are also library files but in an older style ([http://bugs.dwscoalition.org/show_bug.cgi?id=1726 bug 1726] refers to these updates). | ||
| − | + | = [[Main development folder/cvs|cvs]] = | |
The cvs folder contains a local checkout of the [http://hg.dwscoalition.org Mercurial repositories]. Information about use of these repositories can be found at [[http://wiki.dwscoalition.org/notes/Dev_Initial_Programming_Notes]]. | The cvs folder contains a local checkout of the [http://hg.dwscoalition.org Mercurial repositories]. Information about use of these repositories can be found at [[http://wiki.dwscoalition.org/notes/Dev_Initial_Programming_Notes]]. | ||
| Line 20: | Line 18: | ||
| − | + | = doc = | |
Most notable thing in here is source for the old and very much out of date docbook code for the server (LJ's is visible at <code>http://livejournal.com/doc/server/</code> but Dreamwidth has not generated a visible copy), and LJ programming guides. | Most notable thing in here is source for the old and very much out of date docbook code for the server (LJ's is visible at <code>http://livejournal.com/doc/server/</code> but Dreamwidth has not generated a visible copy), and LJ programming guides. | ||
| − | + | = etc = | |
Empty in a clean checkup. Your site's <code>ljconfig.pl</code> will go here, to make sure the original <code>ljconfig.pl</code> can be updated without ill effects on a running installation. | Empty in a clean checkup. Your site's <code>ljconfig.pl</code> will go here, to make sure the original <code>ljconfig.pl</code> can be updated without ill effects on a running installation. | ||
| − | + | = [[Main development folder/htdocs|htdocs]] = | |
This directory contains most of the user-facing pages, with the directory structure used on the main website. That is to say, anything that appears at <code>http://www.dreamwidth.org/filename.bml</code> will be here, as <code>htdocs/filename.bml</code>; anything at <code>http://www.dreamwidth.org/directory/filename.bml</code> will be here as <code>htdocs/directory/filename.bml</code>, etc. To see your changes on your development site, you need to make the changes to the appropriate file in this directory. | This directory contains most of the user-facing pages, with the directory structure used on the main website. That is to say, anything that appears at <code>http://www.dreamwidth.org/filename.bml</code> will be here, as <code>htdocs/filename.bml</code>; anything at <code>http://www.dreamwidth.org/directory/filename.bml</code> will be here as <code>htdocs/directory/filename.bml</code>, etc. To see your changes on your development site, you need to make the changes to the appropriate file in this directory. | ||
| − | + | = logs = | |
Looks to be an empty folder to store logs during running the code. | Looks to be an empty folder to store logs during running the code. | ||
| − | + | = schemes = | |
?? | ?? | ||
| − | + | = [[Main development folder/src|src]] = | |
Confusingly enough, contains source for some of the packages the code uses. Perhaps this is the folder that comes with the distribution and <code>cvs</code> is checked out from the other repositories? Does not contain all of the ones in <code>cvs</code> though. | Confusingly enough, contains source for some of the packages the code uses. Perhaps this is the folder that comes with the distribution and <code>cvs</code> is checked out from the other repositories? Does not contain all of the ones in <code>cvs</code> though. | ||
| − | + | = [[Main development folder/ssldocs|ssldocs]] = | |
This contains pages that are transmitted over SSL instead of being unencrypted. Regular files live in <code>htdocs</code>. | This contains pages that are transmitted over SSL instead of being unencrypted. Regular files live in <code>htdocs</code>. | ||
| − | + | = [[Main development folder/t|t]] = | |
This directory contains the tests that use the testing framework in main/test. See [[Dev Testing]] for how to use them. | This directory contains the tests that use the testing framework in main/test. See [[Dev Testing]] for how to use them. | ||
| − | + | = temp = | |
Empty in a clean install. Probably used for temporary file storage. | Empty in a clean install. Probably used for temporary file storage. | ||
| − | + | = test = | |
Very sparse directory; really not much here. | Very sparse directory; really not much here. | ||
| − | + | = [[Main development folder/views|views]] = | |
This contains [[Template Toolkit]] files, as part of our conversion from BML to Template Toolkit. The controllers for the templates are in <tt>cgi-bin/DW/Controller/</tt>. | This contains [[Template Toolkit]] files, as part of our conversion from BML to Template Toolkit. The controllers for the templates are in <tt>cgi-bin/DW/Controller/</tt>. | ||
Revision as of 11:44, 3 September 2011
This documents the contents of the $LJHOME development folder as checked out by bootstrap.pl and present on all Dreamhacks.
Contents
bin
This directory contains backend utilities for maintaining and upgrading the site.
cgi-bin
This directory contains the code libraries that run the site. This is the base of the library path--that is use Net::OpenID::Consumer; refers to the code in cgi-bin/Net/OpenID/Consumer.pm. It contains all the custom Perl libraries and functions that the code references including the LJ::* and DW::* libraries. Code in *.pl files in this directory are also library files but in an older style (bug 1726 refers to these updates).
cvs
The cvs folder contains a local checkout of the Mercurial repositories. Information about use of these repositories can be found at [[1]].
The two Mercurial source branches you'll be using most often are dw-free dw-free and dw-nonfree dw-nonfree. (When viewing the Mercurial page for each repo, the 'Manifest' link in the top menu bar will allow you to browse the source tree.)
doc
Most notable thing in here is source for the old and very much out of date docbook code for the server (LJ's is visible at http://livejournal.com/doc/server/ but Dreamwidth has not generated a visible copy), and LJ programming guides.
etc
Empty in a clean checkup. Your site's ljconfig.pl will go here, to make sure the original ljconfig.pl can be updated without ill effects on a running installation.
htdocs
This directory contains most of the user-facing pages, with the directory structure used on the main website. That is to say, anything that appears at http://www.dreamwidth.org/filename.bml will be here, as htdocs/filename.bml; anything at http://www.dreamwidth.org/directory/filename.bml will be here as htdocs/directory/filename.bml, etc. To see your changes on your development site, you need to make the changes to the appropriate file in this directory.
logs
Looks to be an empty folder to store logs during running the code.
schemes
??
src
Confusingly enough, contains source for some of the packages the code uses. Perhaps this is the folder that comes with the distribution and cvs is checked out from the other repositories? Does not contain all of the ones in cvs though.
ssldocs
This contains pages that are transmitted over SSL instead of being unencrypted. Regular files live in htdocs.
t
This directory contains the tests that use the testing framework in main/test. See Dev Testing for how to use them.
temp
Empty in a clean install. Probably used for temporary file storage.
test
Very sparse directory; really not much here.
views
This contains Template Toolkit files, as part of our conversion from BML to Template Toolkit. The controllers for the templates are in cgi-bin/DW/Controller/.
