Revision as of 08:23, 6 June 2010

Install and Set Things Up

This may seem like a lot of things to do before you can really get started, things you're probably not familiar with but 1) you can do it 2) you'll only have to do this once.

Get a Dreamhack

What's a Dreamhack? To put it simply, it's an online mirror of the Dreamwidth site which is set up for any developer, beginner or experienced, who asks for it. This way, you don't have to go through the complicated process of installing the Dreamwidth code on your computer.

• Apply for a Dreamhack by filling this form. The two important fields are 'Your Desired Username' and 'Your email address'. Note that your username is the name you'll use to log in to your Dreamhack; it's not the name of your account over there so no need to agonize over it. ;) Your e-mail address is used to send you a welcome e-mail which contains important information as well as maintenance/issue alerts and reinstall e-mails if you need to reinstall so it does matter. Also, some people like having an e-mail account specifically devoted to development. It's up to you.

• Once you're done, you should get an e-mail with your login username and a password. Don't lose it. Once you've gotten this e-mail, you need to install two programs to be able to manage your Dreamhack: PuTTY and WinSCP.

Install PuTTY

What for? PuTTY will allow you to start and stop your Dreamhack, update it when changes are made (either by you or other developers) and generate patches.

• Download PuTTY - choose the 'Windows installer for everything except PuTTYtel' .exe file - and install it.

• Run PuTTY. In the configuration window, enter "hack.dreamwidth.net" for the host name. Go to Connection/Data and enter the username/login given to you in the welcome e-mail. It should be something like dh-username.

• Click on Open. If you get a pop-up message about a key, click Yes.

• Enter the password given to you in the welcome e-mail when asked. Note that no characters are displayed and the cursor won't move. It's normal.

• Change your password by typing:

  passwd

• And that's it for now. :)

Install WinSCP

What for? WinSCP will allow you to browse and edit your Dreamhack files.

• Install WinSCP. During the installation, you may be asked about the mode you prefer: Commander and Explorer. Commander works like an FTP client: a partitioned window with your computer files on one side and the Dreamhack files on the other. Explorer will only display your Dreamhack files and works like Windows's Explorer. I prefer this mode because I don't need to access any files on my computer but choose what's best for you.

• Use "hack.dreamwidth.net" for the host name. Enter your username and password (the new one!). Click on Save then on Login.

Set Up Your Dreamhack

Protect Your Config Files

• Follow the steps outlined at Back Up Your Configs. This will make sure you always have clean copies of your config files in /config-backup.

Go to PuTTY and copy paste the code given to you in the box.

• Follow the steps outlined at Protect your configs from updates. This will create new folders with copies of you config files so that you can safely edit them.

Go to PuTTY and copy paste the code given to you.

Go to WinSCP, to /dw/cvs/local/cvs/.

In the right-sided window, right-click and select New/File. Call it multicvs-private.conf. Type the code given to you in the second box then save.

Go back to PuTTY and copy/paste the code given to you in the third box.

Create Scripts for Routine Tasks

• Create the dwu, dws and dwdb scripts as explained in Scripting.

Go to WinSCP and create the three files in /bin (again by right-clicking) with the code given to you in the boxes. For dwu, use the code from the second box.

Go to PuTTY and make them executable using the chmod ugo+x command. The code you need to type is bolded and is above each box of code.

Manage Your System Account

• Your default Dreamhack account is called system. Go to PuTTY and type:

  $LJHOME/bin/upgrading/make_system.pl

• Log in to your Dreamhack (http://www.yourusername.hack.dreamwidth.net/) using system and your new password.

• Go to http://www.yourusername.hack.dreamwidth.net/admin/priv/. Click on 'payments' type 'system' in the User field then click on 'Make Changes'. The system account now has the ability (privilege) to give paid time to any account.

• Go to http://www.yourusername.hack.dreamwidth.net/admin/pay. Type 'system' in the Edit user field and click on Go. Make your account a seed one.

Get Rid of Invite Codes

• Go to WinSCP, to /dw/cvs/local/etc/, and double-click on config.pl. Find $USE_ACCT_CODES = 1; and change 1 to 0. Save your file.

• Go to PuTTY and type this to make the changes go live on your Dreamhack:

cd $LJHOME
stop-apache
dws
dwdb
start-apache

Create a Bugzilla account

Simply click here.

As mark explained here, go to Name and Password and enter your name following this format: Name [:username]. 'Name' can be your real-like name, a nickname, your username or any name you want. You don't have to enter your real name if you don't want to.

How All of This Works

• Your Dreamhack has two parts:
  • the live part (~/dw/*)
  • two main repository parts (~/dw/cvs/dw-free/* and ~/dw/cvs/dw-nonfree/*).

• What you see on http://yourusername.hack.dreamwidth.net/ is the live part.

• But you work with the repositories: you edit repository files and you create patches in repository folders.

• To test your changes, you need to make the live part match the repository parts. To do that, you use the 'synchronize' and 'update database' scripts you've created earlier:

cd $LJHOME
stop-apache
dws
dwdb
start-apache

• Code is committed by other users all the time. You mustn't forget to regularly update your repositories by running the 'update' script:

cd $LJHOME
stop-apache
dwu
start-apache

Of course, you'll have to run dws and dwdb again after that. You'll do this very often. :)

• You use PuTTY to update your Dreamhack code, create patches and manage patches.

• You use WinSCP to edit Dreamhack files.

• You use Bugzilla to find bugs, file bugs, and upload patches.

Before You Fix Anything

Find or File a Bug

• To find: you can use predefined searches such as unassigned effort-minor.

Some of these bugs won't appear to require 'minor' effort to you. It's normal. Try to find small bugs among them: minor modifications to be done on one of the site pages (text to be modified; elements to be added, removed or moved; elements to be hidden from some categories of users, etc.).

• To file: make sure it's not already been filed using simple search or advanced search then use this form to file a new bug. Fill and edit the fields as needed and don't forget to enter your e-mail address in Assign To and set the status to Assigned if you want to fix it. It's also ok to file a bug you know you're not going to be able to fix. Just leave it as New.

Create a Patch

• First make sure nobody's working on the files you want to edit. If there are already patches up for review/commit, you may need to first import and apply these patches to your Dreamhack to avoid conflicts. You can see patches up for commit by clicking here. You can also wait for them to be committed if you don't want to go to the trouble of importing other patches. There's no rush. :)

• Open PuTTY and update everything. You need to work with the latest code.

• Go to dw-free by typing this then Enter:

cd $LJHOME
tocvs

To go to dw-nonfree, type this then Enter:

cd $LJHOME
tocvs n

• Create a new patch by typing this then Enter (change NUMBER and PATCHNAME of course):

hg qnew -g bugNUMBER_PATCHNAME.diff

Import a Patch

• Go to Bugzilla, open the bug, click on the patch. Copy its URL.

• In PuTTY, go to dw-free:

cd $LJHOME

• Create a new patch (as explained above).

• Import the patch:

wget -O imported_patch URL

This will put the patch in ~/dw/ and name it 'imported_patch'.

• Type this to apply the patch:

patch -p1 < imported_patch

• Type hg addremove if this patch adds or delete files.

• Type hg qrefresh to incorporate the changes into your own patch.

• Synchronize your live code and update your database (as explained above).

Edit Files

Use WinSCP to open the file(s) you need to edit.

• If you're working on site pages, you're working on .bml files. These are in ~dw/cvs/dw-free/htdocs/ or one of the subsequent folders. You'll see that their names correspond to the URLs of site pages. These files may use .pm modules/widgets which are in ~dw/cvs/dw-free/cgi-bin/DW/ or ~dw/cvs/dw-free/cgi-bin/LJ/.

• If you're working on styles, your files is in one of these folders.

• For text strings which are not in ~dw/cvs/dw-free/htdocs/ .bml.text files, see ~dw/cvs/dw-free/bin/upgrading/en.dat.

• For more specific searches, you can use the grep command: grep [option(s)] pattern [file(s)]

Interesting Options:

-E: match using extended regular expressions

-F: match using fixed strings

-r: recursive

-i: case insensitive

-l: filename only

-n: add relative line number

Examples:

grep -ri "find this text" * | more

This will search for "find this text" in all files.

grep -rl print_entry $LJHOME/bin/upgrading/s2layers

This will search for files containing "print_entry" in the /s2layers folder.

• If WinSCP is not using your favorite editor, go to View/Preferences/Editor. Click on Add/External Editor and Browse. At the end don't forget to click on Up to make it the default editor.

Test Your Changes on Your Dreamhack

• In PuTTY, stop your Dreamhack:

cd $LJHOME
stop-apache

• Synchronize your live code and update your database:

dws
dwdb

• Start your Dreamhack again:

start-apache

• Go to your Dreamhack and test. Edit the files again in WinSCP if more changes are needed. Go through these steps again to test your new changes.

Upload Your Patch

Update & Save Your Patch

• In PuTTY, go to your patch directory (see this section if you've forgotten how to).

• Type this if this patch adds or delete files:

hg addremove

• Type this to update your patch file:

hg qrefresh

• Go to your patch directory in WinSCP and save a copy of your patch on your computer (see this section if you've forgotten where the patch folder is).

• Go back to the default code by typing (PATCHNAME is full name with extension too):

hg qpop -a
hg qdelete PATCHNAME

For more commands, see http://hgbook.red-bean.com/read/mercurial-queues-reference.html

Put Your Patch On Bugzilla

• Log in onto Bugzilla and open your bug.

• Click on 'Add an Attachment' to attach your patch. Add a description and check 'patch'. Set Flags/Commit and Flags/Review to ? then click on Commit.

If your patch depends on another patch being reviewed and committed first (you imported this other patch to make yours) then enter its number in the Depends On field and add your patch number in the Blocks field of the other patch. This will let committers know in which order these should be committed.

• Wait for someone to review and commit your patch. :) You're done. Congrats!

Specific Topics for People Working on Style Bugs

Where Are Style Bugs?

Right here!

How do I File a New Style Bug?

Use this template. Fill and edit the fields as needed and don't forget to change the e-mail address in Assign To.

People adding themes can use this template.

Where are Style Files?

• core2.s2 is in ~/dw/cs/dw-free/bin/upgrading/s2layers/

• Theme and layout .s2 files are in ~/dw/cs/dw-free/bin/upgrading/s2layers/LAYERNAME/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/LAYERNAME/

• .pm layout files are in ~/dw/cvs/dw-free/cgi-bin/LJ/S2Theme/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/LAYERNAME/

• S2Theme.pm is in ~/dw/cvs/dw-free/cgi-bin/LJ/

• S2Theme_local.pm is in ~/dw/cvs/dw-nonfree/cgi-bin/LJ/

• s2layers.dat is in ~/dw/cs/dw-free/bin/upgrading/

• s2layers-local.dat is in ~/dw/cs/dw-nonfree/bin/upgrading/

How to Add a Layout

Edit s2layers.dat

• See this section to know where this file is located. Edit s2layers-local.dat for non-free layouts.

• If this is a new Core2 layout, add:

layoutname/layout          layout          core2
layoutname/themes          theme+          layoutname/layout

• If this is a child of Tabula Rasa, add:

layoutname/layout          layout(core2base/layout)    core2
layoutname/themes          theme+                      layoutname/layout

Edit S2Theme.pm

• See this section to know where this file is located. Edit S2Theme_local.pm for non-free layouts.

• Scroll down to %default_themes and add the layout and default theme:

layoutname => 'layoutname/defaulttheme',

Create LAYOUTNAME.pm

• Create LAYOUTNAME.pm in ~/dw/cvs/dw-free/cgi-bin/LJ/S2Theme/.

• Add:

package LJ::S2Theme::layoutname;
use base qw( LJ::S2Theme );
 
sub layouts { ( "1" => "one-column", "2l" => "two-columns-left", "2r" => "two-columns-right", "3" => "three-columns-sides", "3r" => "three-columns-right", "3l" => "three-columns-left" ) }
sub layout_prop { "layout_type" }
 
sub designer { "name" }
 
1;

Remove display options that don't apply to the layout of course.

Create the LAYOUTNAME directory

• Create a directory with the name of the layout in ~/dw/cs/dw-free/bin/upgrading/s2layers/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/.

Create layout.s2

• In the directory you've created, create a file named layout.s2.

layerinfo type = "layout";
layerinfo name = "layoutname";
layerinfo redist_uniq = "layoutname/layout";
layerinfo author_name = "someuser";
layerinfo lang = "en";
 
set layout_authors = [ { "name" => "someuser", "type" => "user" } ];

• Then add the layout code.

Create themes.s2

• In the directory you've created, create a file named themes.s2.

• Follow the steps outlined in this section.

How to Add a Theme

Edit themes.s2

• See this section to know where this file is located.

• Find the correct place in the file so that themes stay alphabetically sorted.

• Make sure your theme header is correctly formatted. As Afuna explained here in dw_dev_training, it should look like this:

#NEWLAYER: layoutname/themename
layerinfo type = "theme";
layerinfo name = "Theme Name";
layerinfo redist_uniq = "layoutname/themename";
layerinfo author_name = "someuser";
 
set layout_authors = [ { "name" => "someuser", "type" => "user" } ];

If you're the layout author, no need to add set layout_authors.

• Then add the theme code.

• If you need to add theme-specific CSS, use:

function Page::print_theme_stylesheet() {
    """
    CSS HERE
    """;
}

• If the theme has any images, name them like this: themename_imagename.xxx. Keep the image name used in other themes if there are any. If they're generic images used in other themes, simply use imagename.xxx. In the theme, use layoutname/themename_imagename.xxx or layoutname/imagename.xxx for the URLs.

Edit LAYOUTNAME.pm

You must include the theme into the general layout file. Otherwise, people wouldn't be able to select it at Customize.

• See this section to know where this file is located.

• Find the correct place in the file so that themes stay alphabetically sorted.

• Add the following code:

package LJ::S2Theme::layoutname::themename;
use base qw( LJ::S2Theme::layoutname );
sub cats { qw( ) }
 
sub designer { "someuser" }

If you're the layout author, no need to add sub designer.

If this is the base layout, type this instead:

sub cats { qw( base ) }

On Bugzilla

• Don't forget to zip images and attach them to your bug if there are any.

Tips and Tricks

• If your repositories won't update properly with dwu, you may need to go to dw-free/dw-nonfree and remove all your local changes with hg update -C then run dwu again.

• If your live code won't sync with your repository code, it may be because the files you've edited got saved using your computer time and not distant time. As the system relies on timestamps to see which files need to be updated, updates won't happen if live files seem to be more recent than repo files. Quickest trick is to change your computer time, open and save your files again so they get a later timestamp, refresh your patch and sync again.

• If there's something wrong with your patch queue (it says the patch is not in the series or you can't delete a patch) don't forget that you can start over: delete the patches folder with WinSCP and recreate it again in PuTTY using hg qinit -c.

• If something's really wrong you can also rebuild you Dreamhack and start over.

• To see what's string of text is used in a page append ?uselang=debug to the page URL.

• As denise explained here, you need to delete old text strings and create new ones when you edit .text files or en.dat instead of simply editing the text. If the change isn't critical - the string doesn't need to be renamed or the text change is minor - it's better to notify the site copy team so that text can be changed locally and the original file left alone.

• If text you've modified doesn't appear on the site after a code push, append ?uselang=debug to make sure it's using the right string. If it is then it may be that things haven't been updated yet.