Merge branch 'master' of orgmode.org:worg
[worg.git] / worg-maintainance.org
1 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
3 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
4 #+TITLE:      Worg maintainance
5 #+AUTHOR:     Worg people
6 #+EMAIL:      mdl AT imapmail DOT org
7 #+LANGUAGE:   en
8 #+PRIORITIES: A C B
9 #+CATEGORY:   worg
10 #+OPTIONS:    H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
11
12 * Worg maintainer
13
14 [[file:users/bzg.org][Bastien]] set up Worg.
15
16 [[file:users/mlundin.org][Matt Lundin]] is the current maintainer.
17
18 ** Maintainer role
19
20 - give push access to new contributors in [[http://orgmode.org/w/worg.git][worg.git]]
21 - access to the server and fix possible publishing issues from there
22
23 * Worg gardners
24
25 « Gardners » are people who take special care of directories, pages or
26 sections in Worg.
27
28 - Matt Lundin is taking special care of [[file:org-faq.org][Worg's FAQ]].
29 - David Maus is taking care of [[file:org-issues.org][org-issues.org]]
30 - [Adopt a directory/page here]
31
32 * Worg doesn't publish correctly - what to do?
33   
34 ** What need to be taken care of?
35
36 /Do we have to avoid certain constructs in the Org files to avoid the bug
37 to come back?/
38
39 Yes, when quoting examples (in org-issues.org or elsewhere), we need to be
40 careful about not including syntactic elements at the wrong place.
41
42 Also, exporting Worg is made using the last Org release, not the latest
43 Org version from git: so anything that is exportable with bleeding-edge
44 Org is not always exportable with the Org version on the server.
45
46 ** How to track down a publishing problem?
47
48 From [[http://lists.gnu.org/archive/html/emacs-orgmode/2010-12/msg01181.html][Bastien's email]] (on 2010-12-24 Fri):
49
50 #+begin_quote
51 Here is how I tracked down the problem if it helps :
52
53 - I tried to export locally with latest Org (from git) to see where the
54   export process stops: I found org-issues.org was the culprit
55
56 - I took a quick look at org-issues.org be couldn't spot the problem
57
58 - I then tried to export by first commenting out the 1st-level trees in
59   org-issues.org except one: reiterated this till I found the ill-formed
60   tree. 
61
62 - Then focus on this tree to find the problem.
63
64 Quick long and a bit too manual - but effective.
65 #+end_quote
66 * Preventing publishing errors
67
68 Locally export any document you edit as HTML (=C-c C-e H=) prior to
69 committing it to Worg and ensure the export process doesn't fail.  This
70 will be more reliable if you're running the latest version of Org.
71
72 You may also want to check the formatting in a browser before committing
73 your change (=C-c C-e b=).
74
75 * Troubleshooting publishing errors
76
77 If you notice Worg isn't updating, visit
78 http://orgmode.org/worg/publishing.txt and look for the export error
79 near the bottom to find the file where publishing stopped.  Locally
80 update to the latest version of Org, open that file, and try reproducing
81 the export error (=C-c C-e H=).  If it's not obvious where the problem is,
82 look at the most recent changes to the file in question:
83
84 : cd Worg
85 : git log -p org-quotes.org
86
87 Try reverting some of those changes and then re-test exporting (=C-c 
88 C-e H=).