Browse code

capture my "how to edit the website" instructions to dcf, for posterity

Roger Dingledine authored on17/10/2013 05:08:47
Showing2 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,43 @@
1
+Here are the instructions I sent David Fifield when he asked about
2
+editing the website. I hope they are useful for you too! --Roger
3
+
4
+See the Makefile.local file in your website/trunk/ directory. Uncomment
5
+TORGIT and point it to a tor git.
6
+
7
+Then apt-get install wml and (alas) probably a shocking number of other
8
+debs. Then you can type 'make' and it will build the website for you
9
+locally. It's probably a smart move to see whether 'make' works before
10
+you svn commit any changes to the wml file.
11
+
12
+You can edit docs/en/pluggable-transports.wml (and that is
13
+the right source file to edit, not the html). But go take a
14
+look at that file. You'll notice it has a bunch of tags like
15
+<version-torobfsbundlelinux64alpha>. If you're just bumping version
16
+numbers, you probably just want to change the definition of those tags.
17
+They're in include/versions.wmi
18
+
19
+(Every once in a while you may need to edit pluggable-transports.wml
20
+too -- generally when you change the file name so drastically that just
21
+changing the versions.wmi tags isn't enough.)
22
+
23
+If you want to push your locally built website to the remote webserver,
24
+run the ./publish script in website/trunk/. It will rsync everything
25
+over, and then it will ask www-master.tp.o to run its trigger-mirrors
26
+script which causes www-master to rsync to all the servers in the www.tp.o
27
+rotation. To push the website, you'll need to be in the torwww ldap group
28
+(which is separate from whether you can commit to svn).
29
+
30
+Alas, https://www.torproject.org/dist/ isn't in version control. You
31
+write to it by ssh'ing to www-master.torproject.org and going to
32
+/srv/www-master.torproject.org/htdocs/dist/ and then sticking your stuff
33
+there. When you want it to go live, you run ./publish from your local
34
+website checkout, which will trigger the trigger-mirrors run. (It's
35
+possible that you can simply run /home/mirroradm/bin/trigger-mirrors on
36
+www-master too, but I've never tried.)
37
+
38
+Weasel has hopes that somebody will write some scripts to make maintaining
39
+packages in dist/ less awful -- automatically check that they have
40
+signatures and that the sigs match, that the items on the website are in
41
+fact in dist, only allow certain people to put files in certain places,
42
+etc. One day! :)
43
+
... ...
@@ -25,6 +25,7 @@ rsync \
25 25
 	--exclude '.*.sw[po]' \
26 26
 	--exclude .deps \
27 27
 	--exclude svn \
28
+	--exclude README \
28 29
 	--exclude dist \
29 30
 	--exclude releases \
30 31
 	--exclude torbutton-current.xpi \