[tor-bugs] #34437 [Internal Services/Service - trac]: migrate help.tpo into a gitlab wiki

Tor Bug Tracker & Wiki blackhole at torproject.org
Thu Jun 11 19:39:58 UTC 2020


#34437: migrate help.tpo into a gitlab wiki
----------------------------------------------+---------------------
 Reporter:  anarcat                           |          Owner:  qbi
     Type:  task                              |         Status:  new
 Priority:  Low                               |      Milestone:
Component:  Internal Services/Service - trac  |        Version:
 Severity:  Minor                             |     Resolution:
 Keywords:                                    |  Actual Points:
Parent ID:                                    |         Points:
 Reviewer:                                    |        Sponsor:
----------------------------------------------+---------------------

Comment (by anarcat):

 Here are the ikiwik macros in use in the wiki:

 {{{
 $ git grep -h '\[\[!' | sed 's/ .*//' | sort | uniq -c | sort -n
       1 [[!toc]]
      10 [[!map
      24 [[!meta
      45 [[!toc
 }}}

  * `[[!toc` can be converted to `[[_TOC_]]`. this is a non-standard "GFM"
 (GitHub Formatted Markdown) extension
  * `[[!meta` should be converted to a
 [https://gitlab.com/help/user/markdown#front-matter front matter] block,
 since it's all titles (the meta directive supports other uses but we don't
 use those). this is a non-standard "GFM" extension
  * `[[!map` has no good equivalent in markdown, but could be replaced by
 the page listings built into the gitlab wiki, on the right column

 I will also note that `[[links|like this]]` would need to be converted as
 well. those are tricky because they need to take into account context of
 the refering page. we have about 184 such links to cover.

 I have written code to convert from ikiwiki's peculiar dialect into a more
 standard (in my case Hugo's) Markdown dialect here:

 https://gitlab.com/anarcat/scripts/-/blob/master/ikiwiki2hugo.py

 that code can probably be reused here, although it only handles the "meta"
 case for now.

 this sounds like a lot of work, but I will note that the longer we wait to
 make this transition, the harder this will be to do correctly, so the
 sooner the better.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/34437#comment:1>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list