worg-maintenance.org

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