tor-webwml.git

README.md  1) # Building website
README.md  2) Torproject website is being built and published automatically.
README.md  3) To quickly get set up and build website locally, simply follow these steps:

README     4) 

README.md  5)  __Step 1:__ Get the website's build dependencies.

README     6) 

README.md  7)     sudo apt-get install wml asciidoc
README.md  8) 
README.md  9)   __Step 2:__ Configure where to find your tor git repository. It needs this to make the

README    10)      manual page.
README    11) 

README.md 12)     git clone https://git.torproject.org/project/web/webwml.git
README.md 13)     cd webwml
README.md 14)     cp Makefile.local.sample Makefile.local
README.md 15)     
README.md 16) Note: Change the `TORGIT` in Makefile.local to point to your tor git repo.

README    17) 

README.md 18)   __Step 3:__ Make the website.

README    19) 

README.md 20)     make

README    21) 
README    22) You should now be able to point your browser at the locally generated site...
README    23) 

README.md 24)     file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en
README.md 25) 

README    26) 

README.md 27) ### Troubleshooting the build

README    28) 

README.md 29) The build fails with "Invalid object name".

README    30) 
README    31)   If you get an error like...
README    32) 
README    33)     ---- Contents of STDERR channel: ---------
README    34)     fatal: Invalid object name 'tor-0.2.6.1-alpha'.
README    35)     asciidoc: FAILED: manpage document title is mandatory
README    36)     No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
README    37) 
README    38)   This means your tor repository is out of date. Update your tor git repository.
README    39) 

README.md 40) 
README.md 41) ### More detailed instructions from Roger
README.md 42) 
README.md 43) _Note: This section was written when website repo was still on svn, and it wasn't built automatically._

README    44) 

README    45) Here are the instructions I sent David Fifield when he asked about
README    46) editing the website. I hope they are useful for you too! --Roger
README    47) 

README    48) Copy Makefile.local.sample to Makefile.local in your webwml/ directory.
README    49) Point TORGIT to a tor git.

README    50) 
README    51) Then apt-get install wml and (alas) probably a shocking number of other
README    52) debs. Then you can type 'make' and it will build the website for you
README    53) locally. It's probably a smart move to see whether 'make' works before

README    54) you git commit any changes to the wml files.

README    55) 
README    56) You can edit docs/en/pluggable-transports.wml (and that is
README    57) the right source file to edit, not the html). But go take a
README    58) look at that file. You'll notice it has a bunch of tags like

README    59) <version-torbrowserbundle>. If you're just bumping version

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

README    67) Pushes to the master branch of the git repository will cause the

README    68) website to get re-built and published. Pushing to the staging branch

README    69) will update www-staging.torproject.org.

README    70) 
README    71) Alas, https://www.torproject.org/dist/ isn't in version control. You

README    72) write to it by ssh'ing to dist-master.torproject.org and going to

README    73) /srv/dist-master.torproject.org/htdocs/ and then sticking your stuff
README    74) there. When you want it to go live, you run

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