Revision as of 11:49, 2 September 2011

This documents the development folder checked out by bootstrap.pl.

Directories you will use a lot

bin

This directory contains backend utilities for maintaining and upgrading the site.

cgi-bin

This directory contains the code that runs 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 functions that the code references, including the LJ::* and DW::* libraries.

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.

ssldocs

This contains pages that are transmitted over SSL instead of being unencrypted. Regular files live in htdocs.

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/.

Special directory

cvs

The cvs folder contains a local checkout of the Mercurial repositories. To generate a patch for your changes that can be applied, you need to make the changes to the appropriate changes in this directory, after you have verified that the changes work, testing them by putting them in htdocs, cgi-bin, or ssldocs and viewing them (and testing them) on your development site. Once you've done that, you can use the automatic tools to sync your "live" directories and your cvs directory. More information 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.)

Directories you will not need to change often

These are directories you won't need to change often, unless you're working on some specific task related to them.

doc

Most notable thing in here is the docbook code for the server 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.

logs

Looks to be an empty folder to store logs during running the code.

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.

t

Looks like this 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.

var

A clean install of this only includes devdata/evillaugh.wav. Nobody remembers what this is for.