Mercurial > p > roundup > code

annotate website/README.txt @ 5955:5dca9925e8a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag 2.0.0alpha0 for changeset d7ff9cb70f34
author John Rouillard <rouilj@ieee.org>
date Wed, 23 Oct 2019 14:33:53 -0400
parents 728a8a25dd70
children 1ae6e7842f39
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
1 Roundup has three web sites:
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
2
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
3 * http://www.roundup-tracker.org/
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
4 * https://wiki.roundup-tracker.org/
5612
da2decb6d0c7 update http://issues.roundup-tracker.org to https://isues.... for the
John Rouillard <rouilj@ieee.org>
parents: 5343
diff changeset
5 * https://issues.roundup-tracker.org/
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
6
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
7 www and wiki are hosted on SourceForge.
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
8
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
9
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
10 updating issues.roundup-tracker.org
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
11 ===================================
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
12 See doc/developers.txt for details on accessing the new location.
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
14
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
15 updating wiki.roundup-tracker.org
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
16 =================================
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
17 Wiki isn't hosted on sourceforge anymore. See:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
18
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
19 https://issues.roundup-tracker.org/issue2551045
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
20
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
21 for details on Implementing wiki move to Waldmann-EDV.
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
22
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
23 Bern Reiter will be adding new docs on how to update files (if
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
24 possible). Old directions are:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
25
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
26 =============
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
27
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
28 copy new files over to new directories:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
29
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
30 cd ${project_home}/src/roundup/website/wiki
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
31 cp -r -p static/roundup ${project_home}/htdocs/_wiki/
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
32 cp -p wiki/data/plugin/theme/roundup.py ${project_home}/persistent/wiki/data/plugin/theme/
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
33 cd -
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
34
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
35 If you need to adjust wiki configuration, it is here:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
36
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
37 vim persistent/wiki/wikiconfig.py
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
38
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
39 ==============
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
40
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
41 updating services hosted on sf.net (www)
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
42 =================================================
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
43 Generic SF instructions for web service recommend
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
44 uploading files through SFTP, described here:
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
45 http://sourceforge.net/p/forge/documentation/Project%20Web%20Services/
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
46
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
47 However, SFTP is ugly to script in non-interactive
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
48 mode, so we use SSH access to fetch everything and
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
49 build from server side.
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
50
5633
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
51 Working with sf.net
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
52 -------------------
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
53 Current docs are taken down with SourceForge Trac,
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
54 so working instructions are available from here:
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
55 http://web.archive.org/web/20140618231150/http://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
56
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
57 # log in, replace <user> with your account
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
58 ssh -t <user>,roundup@shell.sourceforge.net create
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
59
4956
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
60 # set project_home
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
61 project_home=/home/project-web/roundup
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
62
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
63 # pull latest Roundup source with www and wiki
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
64 # (the warning about "Not trusting file ... " can be ignored
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
65 # for now https://sourceforge.net/p/forge/site-support/8217/)
4940
ff4d939f4619 website/README: Make "hg up" location-independent
anatoly techtonik <techtonik@gmail.com>
parents: 4934
diff changeset
66 hg pull -u --cwd ${project_home}/src/roundup
5343
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
67 # see below if this fails with: not trusting file
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
68 # /home/project-web/roundup/src/roundup/.hg/hgrc from untrusted
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
69 # user 110231, group 48
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
70
4956
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
71 # read up on other people changes and add yours
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
72 cd ${project_home}
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
73 vim logbuch.txt
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
74
5343
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
75 If you get a "not trusting" error the problem is that the .hg files in
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
76 use are not owned by you and hg won;t use them. Add this to your
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
77 ~/.hgrc file (create file if needed)
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
78
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
79 [trusted]
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
80 groups=48
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
81 users=110231
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
82
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
83 if the uid/gid changes you may have to change the values.
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
84 See: https://www.mercurial-scm.org/wiki/Trust for details
f1270730505d Add directions on how to handle issues when updating using hg.
John Rouillard <rouilj@ieee.org>
parents: 4956
diff changeset
85
5633
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
86 When done working in the sf shell, you can destroy it early
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
87 to free resources:
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
88
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
89 shutdown
4620
0aafd64866d1 website/README.txt: Improved: Added new generic sf.net section.
Bernhard Reiter <bernhard@intevation.de>
parents: 4609
diff changeset
90
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
91 updating www.roundup-tracker.org
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
92 ---------------------------------
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
93 Site update requires rebuilding HTML files. For that
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
94 you `sphinx` and `sphinxcontrib-cheeseshop` are required/
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
95 Hopefully, they are already installed into virtualenv, so
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
96 the whole procedure looks like so:
4227
25db485027cf add website instructions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
98 # activate the virtualenv
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
99 . ${project_home}/docbuilder/bin/activate
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
100 # cd to website source and build it
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
101 cd ${project_home}/src/roundup/website/www
5845
e338969b1d23 Make sure to update to proper revision now that we have maint branch releases.
John Rouillard <rouilj@ieee.org>
parents: 5633
diff changeset
102 hg up <release tag> # make sure you are using the released code
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
103 make clean
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
104 make html
5633
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
105 # you can check which files updated (the date will change with many files)
7a570b1f0d67 website: improve sf login instructions
Bernhard Reiter <bernhard@intevation.de>
parents: 5612
diff changeset
106 #diff -ur --brief ${project_home}/htdocs/ ./html/
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
107 # copy to website dir
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
108 cp -r -p ./html/* ${project_home}/htdocs/
4956
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
109 # copy legacy html doc to website docs/ dir
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
110 # (in main doc/conf.py this is done automatically)
4e7208743254 Update web site instruction to restore web presence of
anatoly techtonik <techtonik@gmail.com>
parents: 4940
diff changeset
111 cp -r -p ../../doc/html_extra/* ${project_home}/htdocs/docs/
4915
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
112 # or try it with rsync (skip --dry-run when ready)
0e22b13c5ab5 website/README.txt: Test and update instructions
anatoly techtonik <techtonik@gmail.com>
parents: 4871
diff changeset
113 #rsync --dry-run -v --checksum --recursive ./html/* ${project_home}/htdocs/
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
114
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
115
5948
728a8a25dd70 Fix wording.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
116 If you are releasing an alpha/beta release, don't update:
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
117
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
118 ${project_home}/htdocs/docs/
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
119
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
120 instead update:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
121
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
122 ${project_home}/htdocs/dev-docs/
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
123
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
124 and the URL will be: http://www.roundup-tracker.org/dev-docs/docs.html
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
125
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
126 Note there appears to be a cache somewhere in the path, so you may
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
127 need to use:
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
128
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
129 http://www.roundup-tracker.org/dev-docs/docs.html?foo=1
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
130
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5845
diff changeset
131 to cache bust.
Roundup Issue Tracker: http://roundup-tracker.org/