43377598d49ab106be6d8d13fbbceae612b6d4ac
Damian Johnson Improving the readme instru...

Damian Johnson authored 9 years ago

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) 
Roger Dingledine capture my "how to edit the...

Roger Dingledine authored 10 years ago

42) Here are the instructions I sent David Fifield when he asked about
43) editing the website. I hope they are useful for you too! --Roger
44) 
Roger Dingledine update readme to know about...

Roger Dingledine authored 9 years ago

45) Copy Makefile.local.sample to Makefile.local in your webwml/ directory.
46) Point TORGIT to a tor git.
Roger Dingledine capture my "how to edit the...

Roger Dingledine authored 10 years ago

47) 
48) Then apt-get install wml and (alas) probably a shocking number of other
49) debs. Then you can type 'make' and it will build the website for you
50) locally. It's probably a smart move to see whether 'make' works before
Roger Dingledine update readme to know about...

Roger Dingledine authored 9 years ago

51) you git commit any changes to the wml files.
Roger Dingledine capture my "how to edit the...

Roger Dingledine authored 10 years ago

52) 
53) You can edit docs/en/pluggable-transports.wml (and that is
54) the right source file to edit, not the html). But go take a
55) look at that file. You'll notice it has a bunch of tags like
David Fifield Remove torobfsbundlealpha t...

David Fifield authored 10 years ago

56) <version-torbrowserbundle>. If you're just bumping version
Roger Dingledine capture my "how to edit the...

Roger Dingledine authored 10 years ago

57) numbers, you probably just want to change the definition of those tags.
58) They're in include/versions.wmi
59) 
60) (Every once in a while you may need to edit pluggable-transports.wml
61) too -- generally when you change the file name so drastically that just
62) changing the versions.wmi tags isn't enough.)
63) 
Peter Palfrader Somewhat update docs

Peter Palfrader authored 9 years ago

64) Pushes to the master branch of the git repository will cause the
Roger Dingledine update readme to know about...

Roger Dingledine authored 9 years ago

65) website to get re-built and published. Pushing to the staging branch
Peter Palfrader Somewhat update docs

Peter Palfrader authored 9 years ago

66) will update www-staging.torproject.org.
Roger Dingledine capture my "how to edit the...

Roger Dingledine authored 10 years ago

67) 
68) Alas, https://www.torproject.org/dist/ isn't in version control. You
Roger Dingledine update readme to know about...

Roger Dingledine authored 9 years ago

69) write to it by ssh'ing to dist-master.torproject.org and going to
Peter Palfrader Somewhat update docs

Peter Palfrader authored 9 years ago

70) /srv/dist-master.torproject.org/htdocs/ and then sticking your stuff
71) there. When you want it to go live, you run
Roger Dingledine update readme to know about...

Roger Dingledine authored 9 years ago

72) "static-update-component dist.torproject.org" on dist-master.