Mercurial > p > roundup > code

annotate website/README.txt @ 4897:b26176334c88

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix broken links to static html doc files (issue2550840) It seems as though these links have been broken every since sphinx has been used to generate the documentation. Version 1.2 of sphinx introduced the ability to include extra static files, so we are making use of this facility to fix the links to static html files.
author John Kristensen <john@jerrykan.com>
date Mon, 12 May 2014 14:40:53 +1000
parents 8930fe9d6d21
children 0e22b13c5ab5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 issues.roundup-tracker.org:
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 * log into issues.roundup-tracker.org
4598
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
4 * get a working copy of roundup/website/issues from the SCM, either via
4871
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
5 hg clone http://hg.code.sf.net/p/roundup/code
4598
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
6 or download a snapshot:
4871
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
7 http://sourceforge.net/p/roundup/code/ci/default/tarball
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
8
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
9 * check the differences
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
10 diff -ur /home/YOURUSERID/roundup/website/issues/ /home/roundup/trackers/roundup/
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 * copy the files into the tracker instance, using sudo:
4598
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
12 sudo -u roundup cp <file> /home/roundup/trackers/roundup/...
4871
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
13 or use rsync to check and only copy the changed files as user roundup like
4646
cd81ebbce7f9 Minor improvement to the instructions how to maintain our tracker.
Bernhard Reiter <bernhard@intevation.de>
parents: 4620
diff changeset
14 rsync -rvc /home/YOURUSERID/roundup/website/issues/ trackers/roundup/
4871
8930fe9d6d21 Website, Issues: Updated tracker-instructions in README.
Bernhard Reiter <bernhard@intevation.de>
parents: 4830
diff changeset
15 HINT: old files will not be deleted by this rsync command
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 * restart the roundup server:
4646
cd81ebbce7f9 Minor improvement to the instructions how to maintain our tracker.
Bernhard Reiter <bernhard@intevation.de>
parents: 4620
diff changeset
17 sudo /etc/init.d/roundup restart
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
19 [1] All services hosted on sf.net:
4770
278f8bd1fc39 Minor Documentation: of SF shell service access improved.
Bernhard Reiter <bernhard@intevation.de>
parents: 4671
diff changeset
20 * log into sf.net (Generic sf instructions can be found here:
278f8bd1fc39 Minor Documentation: of SF shell service access improved.
Bernhard Reiter <bernhard@intevation.de>
parents: 4671
diff changeset
21 http://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service )
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 ssh -t <user>,roundup@shell.sourceforge.net create
4551
7cd19e56ae4c updates
Richard Jones <richard@users.sourceforge.net>
parents: 4442
diff changeset
23 * set project_home:
7cd19e56ae4c updates
Richard Jones <richard@users.sourceforge.net>
parents: 4442
diff changeset
24 project_home=/home/project-web/roundup
4554
4509e2df25c0 have now set up a virtualenv with the goodies in it so use that
Richard Jones <richard@users.sourceforge.net>
parents: 4551
diff changeset
25 cd ${project_home}
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
26 * read up on other people changes and add yours
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
27 vim ${project_home}/logbuch.txt
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
28 * update the working copy of the SCM roundup source (includes www and wiki)
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
29 cd ${project_home}/src/roundup
4830
10f8b944e60c website: now update command is just 'hg pull -u'
anatoly techtonik <techtonik@gmail.com>
parents: 4780
diff changeset
30 hg pull -u
4780
ccfb6c72ebe2 updated warning text in website/README.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4776
diff changeset
31 (The warning about "Not trusting file /home/hg/p/roundup/code/.hg/hgrc
ccfb6c72ebe2 updated warning text in website/README.txt
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4776
diff changeset
32 from untrusted user" can be ignored.)
4771
0173823161b2 Minor documentation: hints for shell access and wiki.
Bernhard Reiter <bernhard@intevation.de>
parents: 4770
diff changeset
33 * When done working in the shell, you can destroy it early to free resources:
0173823161b2 Minor documentation: hints for shell access and wiki.
Bernhard Reiter <bernhard@intevation.de>
parents: 4770
diff changeset
34 shutdown
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
35
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
36 www.roundup-tracker.org:
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
37 * follow [1].
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
38 * activate the virtualenv
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
39 . ${project_home}/docbuilder/bin/activate
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
40 * go to the now current source directory
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
41 cd ${project_home}/src/roundup/website/www
4666
b247d334dc03 Website Build instructions: added a hint for sphinxcontrib-cheeseshop.
Bernhard Reiter <bernhard@intevation.de>
parents: 4655
diff changeset
42 * (build requirement: sphinx and the sphinxcontrib-cheeseshop plugin
b247d334dc03 Website Build instructions: added a hint for sphinxcontrib-cheeseshop.
Bernhard Reiter <bernhard@intevation.de>
parents: 4655
diff changeset
43 http://pypi.python.org/pypi/sphinxcontrib-cheeseshop)
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 * build it
4554
4509e2df25c0 have now set up a virtualenv with the goodies in it so use that
Richard Jones <richard@users.sourceforge.net>
parents: 4551
diff changeset
45 make html
4551
7cd19e56ae4c updates
Richard Jones <richard@users.sourceforge.net>
parents: 4442
diff changeset
46 * you may also "make clean"
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 * install it
4655
45157fd8ba52 Nicer rsync command for copying over the webpage contents.
Bernhard Reiter <bernhard@intevation.de>
parents: 4646
diff changeset
48 cp -r ./html/* ${project_home}/htdocs/
45157fd8ba52 Nicer rsync command for copying over the webpage contents.
Bernhard Reiter <bernhard@intevation.de>
parents: 4646
diff changeset
49 or alternatively (leaving out the --dry-run later)
45157fd8ba52 Nicer rsync command for copying over the webpage contents.
Bernhard Reiter <bernhard@intevation.de>
parents: 4646
diff changeset
50 rsync --dry-run -v --checksum --recursive ./html/* ${project_home}/htdocs/
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 (I think I can simplify the Makefile above such that the installation will be included as a make target.)
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 wiki.roundup-tracker.org:
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
55 * follow [1].
4771
0173823161b2 Minor documentation: hints for shell access and wiki.
Bernhard Reiter <bernhard@intevation.de>
parents: 4770
diff changeset
56 * the main wiki configuration is here
0173823161b2 Minor documentation: hints for shell access and wiki.
Bernhard Reiter <bernhard@intevation.de>
parents: 4770
diff changeset
57 vim persistent/wiki/wikiconfig.py
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
58 * go to the now current source directory
4598
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
59 cd ${project_home}/src/roundup/website/wiki
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 * copy the files into the right places:
4598
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
61 cp static/roundup/* ${project_home}/htdocs/_wiki/
5c8463b8f7ba Updated README for maintaining the websites (www, wiki, issues)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4554
diff changeset
62 cp wiki/data/plugin/theme/roundup.py ${project_home}/persistent/wiki/data/plugin/theme/
Roundup Issue Tracker: http://roundup-tracker.org/