Mercurial > p > roundup > code

comparison website/README.txt @ 4915:0e22b13c5ab5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
website/README.txt: Test and update instructions
author anatoly techtonik <techtonik@gmail.com>
date Wed, 23 Jul 2014 00:32:00 +0300
parents 8930fe9d6d21
children 53ffa9490fad
comparison
equal deleted inserted replaced
4914:d5bb422da946 4915:0e22b13c5ab5
1 issues.roundup-tracker.org: 1 Roundup has three web sites:
2
3 * http://www.roundup-tracker.org/
4 * http://wiki.roundup-tracker.org/
5 * http://issues.roundup-tracker.org/
6
7 www and wiki are hosted on SourceForge.
8
9
10 updating issues.roundup-tracker.org
11 ===================================
2 12
3 * log into issues.roundup-tracker.org 13 * log into issues.roundup-tracker.org
4 * get a working copy of roundup/website/issues from the SCM, either via 14 * get a working copy of roundup/website/issues from the SCM, either via
5 hg clone http://hg.code.sf.net/p/roundup/code 15 hg clone http://hg.code.sf.net/p/roundup/code
6 or download a snapshot: 16 or download a snapshot:
14 rsync -rvc /home/YOURUSERID/roundup/website/issues/ trackers/roundup/ 24 rsync -rvc /home/YOURUSERID/roundup/website/issues/ trackers/roundup/
15 HINT: old files will not be deleted by this rsync command 25 HINT: old files will not be deleted by this rsync command
16 * restart the roundup server: 26 * restart the roundup server:
17 sudo /etc/init.d/roundup restart 27 sudo /etc/init.d/roundup restart
18 28
19 [1] All services hosted on sf.net:
20 * log into sf.net (Generic sf instructions can be found here:
21 http://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service )
22 ssh -t <user>,roundup@shell.sourceforge.net create
23 * set project_home:
24 project_home=/home/project-web/roundup
25 cd ${project_home}
26 * read up on other people changes and add yours
27 vim ${project_home}/logbuch.txt
28 * update the working copy of the SCM roundup source (includes www and wiki)
29 cd ${project_home}/src/roundup
30 hg pull -u
31 (The warning about "Not trusting file /home/hg/p/roundup/code/.hg/hgrc
32 from untrusted user" can be ignored.)
33 * When done working in the shell, you can destroy it early to free resources:
34 shutdown
35 29
36 www.roundup-tracker.org: 30 updating services hosted on sf.net (www and wiki)
37 * follow [1]. 31 =================================================
38 * activate the virtualenv 32 Generic SF instructions for web service recommend
39 . ${project_home}/docbuilder/bin/activate 33 uploading files through SFTP, described here:
40 * go to the now current source directory 34 http://sourceforge.net/p/forge/documentation/Project%20Web%20Services/
41 cd ${project_home}/src/roundup/website/www
42 * (build requirement: sphinx and the sphinxcontrib-cheeseshop plugin
43 http://pypi.python.org/pypi/sphinxcontrib-cheeseshop)
44 * build it
45 make html
46 * you may also "make clean"
47 * install it
48 cp -r ./html/* ${project_home}/htdocs/
49 or alternatively (leaving out the --dry-run later)
50 rsync --dry-run -v --checksum --recursive ./html/* ${project_home}/htdocs/
51 35
52 (I think I can simplify the Makefile above such that the installation will be included as a make target.) 36 However, SFTP is ugly to script in non-interactive
37 mode, so we use SSH access to fetch everything and
38 build from server side.
53 39
54 wiki.roundup-tracker.org: 40 logging into sf.net
55 * follow [1]. 41 -------------------
56 * the main wiki configuration is here 42 Current docs are taken down with SourceForge Trac,
57 vim persistent/wiki/wikiconfig.py 43 so working instructions are available from here:
58 * go to the now current source directory 44 http://web.archive.org/web/20140618231150/http://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service
59 cd ${project_home}/src/roundup/website/wiki 45
60 * copy the files into the right places: 46 # log in, replace <user> with your account
61 cp static/roundup/* ${project_home}/htdocs/_wiki/ 47 ssh -t <user>,roundup@shell.sourceforge.net create
62 cp wiki/data/plugin/theme/roundup.py ${project_home}/persistent/wiki/data/plugin/theme/ 48
49 # set project_home and go there
50 project_home=/home/project-web/roundup
51 cd ${project_home}
52
53 # read up on other people changes and add yours
54 vim logbuch.txt
55
56 # pull latest Roundup source with www and wiki
57 # (the warning about "Not trusting file ... " can be ignored
58 # for now https://sourceforge.net/p/forge/site-support/8217/)
59 hg pull -u --cwd src/roundup
60
61
62 updating wiki.roundup-tracker.org
63 ---------------------------------
64 wiki doesn't require building anything, so if you're
65 logged in to SF (see above), just copy new files over
66 to new directories:
67
68 cd ${project_home}/src/roundup/website/wiki
69 cp -r -p static/roundup ${project_home}/htdocs/_wiki/
70 cp -p wiki/data/plugin/theme/roundup.py ${project_home}/persistent/wiki/data/plugin/theme/
71 cd -
72
73 If you need to adjust wiki configuration, it is here:
74
75 vim persistent/wiki/wikiconfig.py
76
77
78 updating www.roundup-tracker.org
79 ---------------------------------
80 Site update requires rebuilding HTML files. For that
81 you `sphinx` and `sphinxcontrib-cheeseshop` are required/
82 Hopefully, they are already installed into virtualenv, so
83 the whole procedure looks like so:
84
85 # activate the virtualenv
86 . ${project_home}/docbuilder/bin/activate
87 # cd to website source and build it
88 cd ${project_home}/src/roundup/website/www
89 make clean
90 make html
91 # you can check which files updated
92 #diff -qur ./html/ ${project_home}/htdocs/
93 # copy to website dir
94 cp -r -p ./html/* ${project_home}/htdocs/
95 # or try it with rsync (skip --dry-run when ready)
96 #rsync --dry-run -v --checksum --recursive ./html/* ${project_home}/htdocs/
97
98 When done working in the shell, you can destroy it early
99 to free resources:
100
101 shutdown
Roundup Issue Tracker: http://roundup-tracker.org/