Migrate wiki.sagemath.org contents to more suitable places

[mkoeppe]

The problem with wiki.sagemath.org:

It excludes new and newish developers who do not have the required legacy Trac account but log in to Trac using their GitHub accounts.

Wikis work because of the principle of crowdsourcing. Without a crowd, the material will just become outdated. New material added is indistinguishable from old material.

There is also a conflict between viewing the Wiki (1) as an archive (as a record of past achievements, and perhaps for the benefit of future software archaeologists); (2) as something that is useful for current users and developers; and (3) a place for discussion and planning actions.

These uses are not compatible. We propose to separate these types of material clearly and move each to a more appropriate system.

Source material on wiki.sagemath.org:

• https://wiki.sagemath.org/SageWikiMaintenance%20page
• https://wiki.sagemath.org/TitleIndex

---

Proposed targets:

Migration to GitHub issues

Ticket/issue descriptions can be used for collecting/curating/staging material that eventually should be added to our documentation or to our code.

• Meta-ticket: document configuring IDEs and text editors #30500 Meta-ticket: document configuring IDEs and text editors
• Meta-ticket: Add downstream (external user) packages as optional/experimental packages #31164 Meta-ticket: Add user packages from https://wiki.sagemath.org/SageMathExternalPackages as optional/experimental packages

Migration to our documentation

(needs conversion to rst)

• Developer's Guide: Update reviewer's check list from wiki #33649 Developer's Guide: Update reviewer's check list from wiki
• Developer guide: Check material in https://wiki.sagemath.org/TentativeConventions #33663 Developer guide: Check material in https://wiki.sagemath.org/TentativeConventions
• Merge https://wiki.sagemath.org/CodeSharingWorkflow into developer manual #34554 Merge https://wiki.sagemath.org/CodeSharingWorkflow into developer manual

Current drawback: The documentation is only updated one every stable release (to be fixed in #33862)

either: Migration to www.sagemath.org

(needs conversion to html; or website scripts need extension to handle markdown or moinmoin sources; https://python-markdown.github.io/reference/; https://github.com/github/markup)

• This would be suitable for example for archiving https://wiki.sagemath.org/Workshops

• Migrate old Sage release tours and changelogs from Sage website and wiki to GitHub Releases or Sage documentation #31533 Migrate old Sage release tours from Sage wiki

• Merge info from https://wiki.sagemath.org/CategoryHomepage into contributors.xml

or: Migration to GitHub wiki:

This is where we moved the contents of the Trac wiki.

"Note: Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use GitHub Pages in a public repository." https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

---

Considered but won't be needed:

Migration to GitHub pages:

https://pages.github.com/

(needs conversion to markdown)

Unclear why we should create a new website when we already have www.sagemath.org

---

Format conversion tools, workflow:

• https://github.com/swenson/sagewiki -> forked as https://github.com/sagemath/sagewiki-to-github

• Convert directly to Markdown using https://github.com/phlash/moin2markdown

• https://pypi.org/project/moin2gitwiki/

• To do while migrating: We also audit/update our documentation regarding links to the wiki.

  $ git grep 'wiki[.]sage'
  

References:

• http://moinmo.in/HelpOnConfiguration

CC: @slel @dimpase @sagetrac-tmonteil @fchapoton @saraedum @kwankyu @williamstein @haraldschilly @jhpalmieri

Component: website/wiki

Issue created by migration from https://trac.sagemath.org/ticket/33725

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,17 @@
 As proposed in https://groups.google.com/g/sage-devel/c/Acy5nNZWaUA/m/DuqGh3JkCwAJ
+
+The Trac wiki appears to understand most of the old Sage wiki's markup, except:
+
+- In section headers, [CamelCase](../wiki/CamelCase) words need to be escaped with "!"
+- edit the markup for included images
+- automatic table of contents no longer works. 
+
+Wanted: a script that helps with this
+
+Related content migration tickets:
+
+- #30500 Meta-ticket: document configuring IDEs and text editors
+- #31164 Meta-ticket: Add user packages from https://wiki.sagemath.org/SageMathExternalPackages as optional/experimental packages
 
 See
 - https://wiki.sagemath.org/SageWikiMaintenance%20page

[mkoeppe]

Description changed:

--- 
+++ 
@@ -4,6 +4,7 @@
 
 - In section headers, [CamelCase](../wiki/CamelCase) words need to be escaped with "!"
 - edit the markup for included images
+  - `{{https://patchbot.sagemath.org/svg/Pending||width=48}}` changes to `<img src="https://patchbot.sagemath.org/svg/Pending" width=48>`
 - automatic table of contents no longer works. 
 
 Wanted: a script that helps with this

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,6 +1,6 @@
 As proposed in https://groups.google.com/g/sage-devel/c/Acy5nNZWaUA/m/DuqGh3JkCwAJ
 
-The Trac wiki appears to understand most of the old Sage wiki's markup, except:
+The [Trac wiki](https://trac.edgewall.org/wiki/WikiFormatting) markup appears to understand most of the old Sage wiki's markup, except:
 
 - In section headers, [CamelCase](../wiki/CamelCase) words need to be escaped with "!"
 - edit the markup for included images

[sagetrac-tmonteil]

comment:4

Please don't. In terms of infrastructure, the wiki is pretty well hosted, while the VM that hosts the trac+wiki is unmaintained, so this looks like a regression to me (at least right now).

[dimpase]

comment:5

I think that trac is better, as it allows contributions with github logins. And the bus factor of the present wiki hosting is rather small.

[mkoeppe]

comment:6

It's critical that we get rid of the old Sage wiki. As Dima says - it excludes new developers.

Trac is maintained because it has to be (thanks to all who keep it running!) The wiki part of it places no additional burden on maintaining Trac.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,4 @@
-As proposed in https://groups.google.com/g/sage-devel/c/Acy5nNZWaUA/m/DuqGh3JkCwAJ
+As proposed in https://groups.google.com/g/sage-devel/c/Acy5nNZWaUA/m/DuqGh3JkCwAJ and https://groups.google.com/g/sage-devel/c/4ysVRpYGU_E
 
 The [Trac wiki](https://trac.edgewall.org/wiki/WikiFormatting) markup appears to understand most of the old Sage wiki's markup, except:
 

[mkoeppe]

Description changed:

--- 
+++ 
@@ -5,7 +5,7 @@
 - In section headers, [CamelCase](../wiki/CamelCase) words need to be escaped with "!"
 - edit the markup for included images
   - `{{https://patchbot.sagemath.org/svg/Pending||width=48}}` changes to `<img src="https://patchbot.sagemath.org/svg/Pending" width=48>`
-- automatic table of contents no longer works. 
+- Replace `<<TableOfContents>>` by `[[PageOutline]]`
 
 Wanted: a script that helps with this
 

[mkoeppe]

Description changed:

--- 
+++ 
@@ -7,7 +7,11 @@
   - `{{https://patchbot.sagemath.org/svg/Pending||width=48}}` changes to `<img src="https://patchbot.sagemath.org/svg/Pending" width=48>`
 - Replace `<<TableOfContents>>` by `[[PageOutline]]`
 
-Wanted: a script that helps with this
+A command that helps with this:
+
+```
+sed 's/<<TableOfContents>>/[[PageOutline]]/;' INPUT > OUTPUT
+```
 
 Related content migration tickets: