worg-maintenance.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 maintenance
   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 f:t *:t tex:t d:(HIDE) tags:not-in-toc ':t
  11
  12 * Worg maintainer
  13
  14 [[file:users/bzg.org][Bastien]] set up Worg but new maintainers are welcome!
  15
  16 The role of the maintainers is to allow new users and to monitor
  17 commits made on [[https://code.orgmode.org/bzg/worg/][the Worg repository]].
  18
  19 * Worg doesn't publish correctly - what to do?
  20
  21 ** What need to be taken care of?
  22
  23 /Do we have to avoid certain constructs in the Org files to avoid the
  24 bug to come back?/
  25
  26 Yes, when quoting examples (in org-issues.org or elsewhere), we need
  27 to be careful about not including syntactic elements at the wrong
  28 place.
  29
  30 Also, exporting Worg is made using the last Org release, not the
  31 latest Org version from git: so anything that is exportable with
  32 bleeding-edge Org is not always exportable with the Org version on the
  33 server.
  34
  35 ** How to track down a publishing problem?
  36
  37 From [[http://lists.gnu.org/archive/html/emacs-orgmode/2010-12/msg01181.html][Bastien's email]] (on 2010-12-24 Fri):
  38
  39 #+begin_quote
  40 Here is how I tracked down the problem if it helps :
  41
  42 - I tried to export locally with latest Org (from git) to see where
  43   the export process stops: I found org-issues.org was the culprit
  44
  45 - I took a quick look at org-issues.org be couldn't spot the problem
  46
  47 - I then tried to export by first commenting out the 1st-level trees
  48   in org-issues.org except one: reiterated this till I found the
  49   ill-formed tree.
  50
  51 - Then focus on this tree to find the problem.
  52
  53 Quick long and a bit too manual - but effective.
  54 #+end_quote
  55 * Preventing publishing errors
  56
  57 Locally export any document you edit as HTML (=C-c C-e h H=) prior to
  58 committing it to Worg and ensure the export process doesn't fail.
  59 This will be more reliable if you're running the latest version of
  60 Org.
  61
  62 You may also want to check the formatting in a browser before
  63 committing your change (=C-c C-e h o=).
  64
  65 * Troubleshooting publishing errors
  66
  67 If you notice Worg isn't updating, visit [[https://orgmode.org/worg/publishing.txt][publishing.txt]] and look for
  68 the export error near the bottom to find the file where publishing
  69 stopped.  Locally update to the latest version of Org, open that file,
  70 and try reproducing the export error (=C-c C-e h H=).  If it's not
  71 obvious where the problem is, look at the most recent changes to the
  72 file in question:
  73
  74 : cd Worg
  75 : git log -p org-quotes.org
  76
  77 Try reverting some of those changes and then re-test exporting (=C-c
  78 C-e h H=).