tor-webwml.git

README.md   1) # How to contribute
README.md   2) 
README.md   3) Thanks for being interested to work on the website, I tried to make a simple how-to for you to quickly get you setup:
README.md   4) 
README.md   5) __Step 1:__ Clone the git repo.
README.md   6) 
README.md   7)     git clone https://git.torproject.org/project/web/webwml.git
README.md   8)     cd webwml
README.md   9) 
README.md  10) __Step 1b:__ Create a bare public repository (i.e on Github), where you'd push your commits to. Make sure you're in `webwml` directory, and run:
README.md  11) 
README.md  12)     git remote add pick-a-name your-git-url
README.md  13) 
README.md  14) _Example:_
README.md  15)     `git remote tpo-gh git@github.com:mrphs/tpo.git`
README.md  16) 
README.md  17) __Step 2:__ Create and switch to a new branch.
README.md  18) 
README.md  19) _In the following example, I've named my branch "docs" as I'm planning to work on the documentations._
README.md  20) 
README.md  21)     git checkout -b docs
README.md  22) 
README.md  23) __Step 3:__ Now you can start working on website and make changes. Once you're done, commit and push it to your public repo.
README.md  24) 
README.md  25) _Example:_
README.md  26) 
README.md  27)     git push tpo-gh docs
README.md  28) 
README.md  29) __Step 4:__ Open a new ticket on [trac](https://trac.torproject.org) with a link to your shiny new repo/branch.
README.md  30) 

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

README     34) 

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

README     36) 

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

README     40)      manual page.
README     41) 

README.md  42)     git clone https://git.torproject.org/project/web/webwml.git
README.md  43)     cd webwml
README.md  44)     cp Makefile.local.sample Makefile.local
README.md  45)     
README.md  46) Note: Change the `TORGIT` in Makefile.local to point to your tor git repo.

README     47) 

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

README     49) 

README.md  50)     make

README     51) 
README     52) You should now be able to point your browser at the locally generated site...
README     53) 

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

README     56) 

README.md  57) ### Troubleshooting the build

README     58) 

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

README     60) 
README     61)   If you get an error like...
README     62) 
README     63)     ---- Contents of STDERR channel: ---------
README     64)     fatal: Invalid object name 'tor-0.2.6.1-alpha'.
README     65)     asciidoc: FAILED: manpage document title is mandatory
README     66)     No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
README     67) 
README     68)   This means your tor repository is out of date. Update your tor git repository.
README     69) 

README.md  70) 
README.md  71) ### More detailed instructions from Roger
README.md  72) 
README.md  73) _Note: This section was written when website repo was still on svn, and it wasn't built automatically._

README     74) 

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

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

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

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

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

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

README     90) numbers, you probably just want to change the definition of those tags.
README     91) They're in include/versions.wmi
README     92) 
README     93) (Every once in a while you may need to edit pluggable-transports.wml
README     94) too -- generally when you change the file name so drastically that just
README     95) changing the versions.wmi tags isn't enough.)
README     96) 

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

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

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

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

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

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

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