On Apr 20, 2022, at 1:36 AM, Adi Roiban <adiroiban@gmail.com> wrote:
Hi,
As part of the plan to stop using Trac for Twisted project management, we need to find a way to migrate / archive the existing wiki pages from here
https://twistedmatrix.com/trac/wiki
I see 2 options
-------------
Option 1 - Migrate to GitHub own Wiki pages
I have already done a test migration. You can see an example here Page https://github.com/twisted/twisted/wiki/ReviewProcess History https://github.com/twisted/twisted/wiki/ReviewProcess/_history
Pros: * The wiki page edit history is preserved * Wiki has a separate repo * The wiki can be now edited with Git * GitHub Wiki supports RST or Markdown format Cons: * GitHub Wiki has no support for Trac Wiki format.. so we need some sort of conversion * Continues to depend more on GitHub
There’s an important “con” missing here which I think makes this Option 1 a non-starter: in order to not break links to the existing website, we need to host all the pages (or at least have redirect mappings set up) on our existing website anyway. Having no process to update those mappings means we need stub wiki pages to stick around forever.
---------------
Option 2 - Migrate the latest Wiki snapshot to a Python Sphinx based website
You can see an example here https://judgegregg.github.io/sphinxwiki/content/pages/ReviewProcess
Code is at https://github.com/twisted/twisted.github.io/pull/10
Pros: * Uses Sphinx and we are already familiar with that
Cons: * The revision history is not visible from the web page (still can be available via the source repo)
---------
I am for using option 1, but only as an "archive". I am also able to allocate all the required resources in order to make this happen :) Any wiki page of value, should be migrated to our official documentation at https://docs.twistedmatrix.com
For example, there is this PR to migrate the security wiki page to our official documentation https://github.com/twisted/twisted/pull/1712
And if that PR is reviewed, I plan to migrate the ReviewProcess wiki page next.
I am against option 2. We already have https://docs.twistedmatrix.com using Sphinx, hence I am not happy with having 2 separate Sphinx sites for Twisted.
----------
What do **you** think?
You can send your feedback over email or over IRC or Gitter.
Thanks -- Adi Roiban _______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/CJNR5LRRNYP... Code of Conduct: https://twisted.org/conduct