GitList
Browse code

Update and rename README to README.md

- Applying markdown format and some prettifying.
- Adding a note to arma's instruction.

Nima Fatemi authored on 15/11/2014 00:40:26
Showing 1 changed files
README
History View file @ 331982f83
1 1 
deleted file mode 100644
... ... 
@@ -1,79 +0,0 @@
1 
-To quickly get set up simply do the following...
2 
-
3 
-  1. Get the website's build dependencies.
4 
-
5 
-    % sudo apt-get install wml asciidoc
6 
-
7 
-  2. Configure where to find your tor git repository. It needs this to make the
8 
-     manual page.
9 
-
10 
-    % git clone https://git.torproject.org/project/web/webwml.git
11 
-    % cd webwml
12 
-    % cp Makefile.local.sample Makefile.local
13 
-    [ change the TORGIT in Makefile.local to point to your tor git repo ]
14 
-
15 
-  3. Make the website.
16 
-
17 
-    % make
18 
-
19 
-You should now be able to point your browser at the locally generated site...
20 
-
21 
-  file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en
22 
-
23 
-Troubleshooting
24 
-
25 
-* The build fails with "Invalid object name".
26 
-
27 
-  If you get an error like...
28 
-
29 
-    ---- Contents of STDERR channel: ---------
30 
-    fatal: Invalid object name 'tor-0.2.6.1-alpha'.
31 
-    asciidoc: FAILED: manpage document title is mandatory
32 
-    No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
33 
-
34 
-  This means your tor repository is out of date. Update your tor git repository.
35 
-
36 
-More detailed instructions from Roger
37 
-
38 
-Here are the instructions I sent David Fifield when he asked about
39 
-editing the website. I hope they are useful for you too! --Roger
40 
-
41 
-Copy Makefile.local.sample to Makefile.local in your webwml/ directory.
42 
-Point TORGIT to a tor git.
43 
-
44 
-Then apt-get install wml and (alas) probably a shocking number of other
45 
-debs. Then you can type 'make' and it will build the website for you
46 
-locally. It's probably a smart move to see whether 'make' works before
47 
-you git commit any changes to the wml files.
48 
-
49 
-You can edit docs/en/pluggable-transports.wml (and that is
50 
-the right source file to edit, not the html). But go take a
51 
-look at that file. You'll notice it has a bunch of tags like
52 
-<version-torbrowserbundle>. If you're just bumping version
53 
-numbers, you probably just want to change the definition of those tags.
54 
-They're in include/versions.wmi
55 
-
56 
-(Every once in a while you may need to edit pluggable-transports.wml
57 
-too -- generally when you change the file name so drastically that just
58 
-changing the versions.wmi tags isn't enough.)
59 
-
60 
-Pushes to the master branch of the git repository will cause the
61 
-website to get re-built and published. Pushing to the staging branch
62 
-will update www-staging.torproject.org.
63 
-
64 
-Alas, https://www.torproject.org/dist/ isn't in version control. You
65 
-write to it by ssh'ing to dist-master.torproject.org and going to
66 
-/srv/dist-master.torproject.org/htdocs/ and then sticking your stuff
67 
-there. When you want it to go live, you run
68 
-"static-update-component dist.torproject.org" on dist-master.
69 
-
70 
-Weasel has hopes that somebody will write some scripts to make maintaining
71 
-packages in dist/ less awful -- automatically check that they have
72 
-signatures and that the sigs match, that the items on the website are in
73 
-fact in dist, only allow certain people to put files in certain places,
74 
-etc. One day! :)
75 
-
Browse code

Improving the readme instructions

Roger's instructions were nice, but they were still a wall of text. When I run
into a readme I want it to help me get things set up quickly. As such, adding
brief setup instrucions and a troubleshooting section. Roger's instructions
were also missing the ascidoc dependency.

Damian Johnson authored on 14/11/2014 17:34:04
Showing 1 changed files
README
History View file @ 43377598d
... ... 
@@ -1,3 +1,44 @@
1 
+To quickly get set up simply do the following...
2 
+
3 
+  1. Get the website's build dependencies.
4 
+
5 
+    % sudo apt-get install wml asciidoc
6 
+
7 
+  2. Configure where to find your tor git repository. It needs this to make the
8 
+     manual page.
9 
+
10 
+    % git clone https://git.torproject.org/project/web/webwml.git
11 
+    % cd webwml
12 
+    % cp Makefile.local.sample Makefile.local
13 
+    [ change the TORGIT in Makefile.local to point to your tor git repo ]
14 
+
15 
+  3. Make the website.
16 
+
17 
+    % make
18 
+
19 
+You should now be able to point your browser at the locally generated site...
20 
+
21 
+  file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en
22 
+
23 
+--------------------------------------------------------------------------------
24 
+Troubleshooting
25 
+--------------------------------------------------------------------------------
26 
+
27 
+* The build fails with "Invalid object name".
28 
+
29 
+  If you get an error like...
30 
+
31 
+    ---- Contents of STDERR channel: ---------
32 
+    fatal: Invalid object name 'tor-0.2.6.1-alpha'.
33 
+    asciidoc: FAILED: manpage document title is mandatory
34 
+    No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
35 
+
36 
+  This means your tor repository is out of date. Update your tor git repository.
37 
+
38 
+--------------------------------------------------------------------------------
39 
+More detailed instructions from Roger
40 
+--------------------------------------------------------------------------------
41 
+
1 42 
 Here are the instructions I sent David Fifield when he asked about
2 43 
 editing the website. I hope they are useful for you too! --Roger
3 44
Browse code

update readme to know about git

Roger Dingledine authored on 20/10/2014 02:34:18
Showing 1 changed files
README
History View file @ 87ab12b73
... ... 
@@ -1,13 +1,13 @@
1 1 
 Here are the instructions I sent David Fifield when he asked about
2 2 
 editing the website. I hope they are useful for you too! --Roger
3 3
4 
-See the Makefile.local file in your website/trunk/ directory. Uncomment
5 
-TORGIT and point it to a tor git.
4 
+Copy Makefile.local.sample to Makefile.local in your webwml/ directory.
5 
+Point TORGIT to a tor git.
6 6
7 7 
 Then apt-get install wml and (alas) probably a shocking number of other
8 8 
 debs. Then you can type 'make' and it will build the website for you
9 9 
 locally. It's probably a smart move to see whether 'make' works before
10 
-you svn commit any changes to the wml file.
10 
+you git commit any changes to the wml files.
11 11
12 12 
 You can edit docs/en/pluggable-transports.wml (and that is
13 13 
 the right source file to edit, not the html). But go take a
... ... 
@@ -21,14 +21,14 @@ too -- generally when you change the file name so drastically that just
21 21 
 changing the versions.wmi tags isn't enough.)
22 22
23 23 
 Pushes to the master branch of the git repository will cause the
24 
-website to get re-built and published.  pushing to the staging branch
24 
+website to get re-built and published. Pushing to the staging branch
25 25 
 will update www-staging.torproject.org.
26 26
27 27 
 Alas, https://www.torproject.org/dist/ isn't in version control. You
28 
-write to it by ssh'ing to staticiforme.torproject.org and going to
28 
+write to it by ssh'ing to dist-master.torproject.org and going to
29 29 
 /srv/dist-master.torproject.org/htdocs/ and then sticking your stuff
30 30 
 there. When you want it to go live, you run
31 
-static-update-component dist.torproject.org on staticiforme.
31 
+"static-update-component dist.torproject.org" on dist-master.
32 32
33 33 
 Weasel has hopes that somebody will write some scripts to make maintaining
34 34 
 packages in dist/ less awful -- automatically check that they have
Browse code

Somewhat update docs

Peter Palfrader authored on 18/10/2014 00:29:37
Showing 1 changed files
README
History View file @ 40bfc7e4a
... ... 
@@ -20,20 +20,15 @@ They're in include/versions.wmi
20 20 
 too -- generally when you change the file name so drastically that just
21 21 
 changing the versions.wmi tags isn't enough.)
22 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).
23 
+Pushes to the master branch of the git repository will cause the
24 
+website to get re-built and published.  pushing to the staging branch
25 
+will update www-staging.torproject.org.
29 26
30 27 
 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.)
28 
+write to it by ssh'ing to staticiforme.torproject.org and going to
29 
+/srv/dist-master.torproject.org/htdocs/ and then sticking your stuff
30 
+there. When you want it to go live, you run
31 
+static-update-component dist.torproject.org on staticiforme.
37 32
38 33 
 Weasel has hopes that somebody will write some scripts to make maintaining
39 34 
 packages in dist/ less awful -- automatically check that they have
Browse code

Remove torobfsbundlealpha tags, no longer used.

These pointed to the 2.x-series pluggable transports bundles. Everything
is reorganized now with the 3.x series.

David Fifield authored on 29/03/2014 17:16:23
Showing 1 changed files
README
History View file @ 4d71689cb
... ... 
@@ -12,7 +12,7 @@ you svn commit any changes to the wml file.
12 12 
 You can edit docs/en/pluggable-transports.wml (and that is
13 13 
 the right source file to edit, not the html). But go take a
14 14 
 look at that file. You'll notice it has a bunch of tags like
15 
-<version-torobfsbundlelinux64alpha>. If you're just bumping version
15 
+<version-torbrowserbundle>. If you're just bumping version
16 16 
 numbers, you probably just want to change the definition of those tags.
17 17 
 They're in include/versions.wmi
18 18
Browse code

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

Roger Dingledine authored on 17/10/2013 05:08:47
Showing 1 changed files
README
History View file @ 81f0fb786
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 
+