Difference between revisions of "User talk:Jeshyr"
| Line 4: | Line 4: | ||
| − | = | + | = bin = |
| − | + | Backend utilities for maintaining and upgrading the site. | |
| − | = | + | = cgi-bin = |
| − | + | The code libraries that power the site. This directory 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). | |
| − | = | + | = cvs = |
| − | + | Local version of the [http://hg.dwscoalition.org Mercurial repositories]. Information about use of these repositories can be found in the [[http://wiki.dwscoalition.org/notes/Dev_Initial_Programming_Notes Developers' Initial Programming Notes]]. | |
The two Mercurial source branches you'll be using most often are <code>dw-free</code> [http://hg.dwscoalition.org/dw-free/ dw-free] and <code>dw-nonfree</code> [http://hg.dwscoalition.org/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.) | The two Mercurial source branches you'll be using most often are <code>dw-free</code> [http://hg.dwscoalition.org/dw-free/ dw-free] and <code>dw-nonfree</code> [http://hg.dwscoalition.org/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.) | ||
| Line 23: | Line 23: | ||
= doc = | = doc = | ||
| − | + | Unedited versions of some configuration files are stored here. | |
| + | |||
| + | == raw == | ||
| + | |||
| + | Docbook formatted source for the old and very much out of date docbook code for the LiveJournal server. LiveJournal's version is visible at <code>http://livejournal.com/doc/server/</code> but Dreamwidth has not generated a user-visible copy. | ||
= etc = | = etc = | ||
| − | + | Various configuration files specific to the local site, such as <code>ljconfig.pl</code>. These files are not copied to the Mercurial repositories so they can be updated without affecting other running installations. | |
| − | = | + | = htdocs = |
| − | + | User-facing BML 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. | |
= logs = | = logs = | ||
| − | + | Is this directory even used? | |
| − | = | + | = schemes = |
The [[Template Toolkit]] (<code>*.tt</code>) files for generating the site schemes used on Dreamwidth. | The [[Template Toolkit]] (<code>*.tt</code>) files for generating the site schemes used on Dreamwidth. | ||
| − | = | + | = src = |
| − | + | Source code 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. | |
| − | = | + | = 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>. | ||
| − | = | + | = t = |
| − | + | Tests that use the testing framework in main/test. See [[Dev Testing]] for how to use them. | |
= temp = | = temp = | ||
| − | + | Probably used for temporary file storage, but what temporary files? | |
= test = | = test = | ||
| − | + | What's this? | |
= [[Main development folder/views|views]] = | = [[Main development folder/views|views]] = | ||
| − | + | [[Template Toolkit]] files which are gradually replacing the BML files. The controllers for the templates are in <tt>cgi-bin/DW/Controller/</tt>. | |
Revision as of 12:06, 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
Backend utilities for maintaining and upgrading the site.
cgi-bin
The code libraries that power the site. This directory 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
Local version of the Mercurial repositories. Information about use of these repositories can be found in the [Developers' Initial Programming Notes].
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
Unedited versions of some configuration files are stored here.
raw
Docbook formatted source for the old and very much out of date docbook code for the LiveJournal server. LiveJournal's version is visible at http://livejournal.com/doc/server/ but Dreamwidth has not generated a user-visible copy.
etc
Various configuration files specific to the local site, such as ljconfig.pl. These files are not copied to the Mercurial repositories so they can be updated without affecting other running installations.
htdocs
User-facing BML 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.
logs
Is this directory even used?
schemes
The Template Toolkit (*.tt) files for generating the site schemes used on Dreamwidth.
src
Source code 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
Tests that use the testing framework in main/test. See Dev Testing for how to use them.
temp
Probably used for temporary file storage, but what temporary files?
test
What's this?
views
Template Toolkit files which are gradually replacing the BML files. The controllers for the templates are in cgi-bin/DW/Controller/.
