First Draft of Trac migration to Pelican

[JudgeGregg]

This is my first try at migrating trac pages to RST Pelican.

So far 32 pages have been merged, including (I think) the most important ones about contributing.

I've used twisted.org as the main host, but can revert easily to twisted.github.io if need be.

There are still areas of improvement on the currently migrated pages:

• a few links are broken
• some title weights are incorrect
• I have to fix the trac links currently labeled as fixme

Also I don't know which pages are obsolete and don't really need migrating.

• CI pages seem obsolete
• GSOC and WomenOutreach as well?
• What about Infrastructure?

I plan on:

• fixing the actual issues with the currently migrated pages
• add new pages on a regular basis

[graingert]

twisted.github.io redirects to twisted.org so that should be ok?

[graingert]

@JudgeGregg thanks so much for your work on this! do you have somewhere I can preview the rendering of this?

[JudgeGregg]

Yes, just wanted to be sure :)

Also, the good news is that the files are almost pure RST, (apart from the internal pages links, specific to Pelican), so migrating to another Wiki should be easier if needed.

[JudgeGregg]

@JudgeGregg thanks so much for your work on this! do you have somewhere I can preview the rendering of this?
Yes, at
https://judgegregg.github.io/peliwiki/

[graingert]

I suspect we'll probably want something like this? https://github.com/marketplace/actions/github-pages-pelican-build-action

I've currently got the repo configured as a bare github pages project so I'll need to tweak the branch to gh-pages

[JudgeGregg]

It should work, although I'm not familiar at all with GH Actions.
Maybe GH_PAGES_BRANCH could be set to "main", that way we won't need gh-pages?

[graingert]

Maybe GH_PAGES_BRANCH could be set to "main", that way we won't need gh-pages?

I think this will cause the action to push to main recursively

[graingert]

the

Want to use Twisted for web development? Please read this page first!

link is a 404 for me https://judgegregg.github.io/peliwiki/%7Bfilename%7D/pages/WebDevelopmentWithTwisted.rst

[JudgeGregg]

Ok I'll focus on T-Web next. Any page with "filename" in its url means it's a broken internal link, because the page hasn't been migrated, or it's a typo.

[graingert]

@JudgeGregg there's at least three threads of discussion here

• eg how to go about building and automating deploying the content
• what content to include/exclude eg legacy stuff about CI that's obsolete
• technical details about the current implementation eg as you mentioned - typos, or broken links

I enabled "discussions" to facilitate this https://github.com/twisted/twisted.github.io/discussions

[JudgeGregg]

Ok thanks, I'll open the relevant discussions there :)

[graingert]

@JudgeGregg perhaps a "show and tell" discussion and I can start three nested threads there?

[adiroiban]

The theme was updated in "main" branch.

I happy to merge a pelican PR which builds on top of the current theme and as a start adds support for a "blog" so that we have a static landing page, but we can also replace https://labs.twistedmatrix.com/ in a single site.

Thanks!

[JudgeGregg]

Thank you, I updated the sites with the new index page.

In order to summarize, so far we have:
https://judgegregg.github.io/peliwiki/ -> 37 wiki pages migrated to pelican RST like
https://judgegregg.github.io/sphinxwiki/ -> 37 wiki pages migrated to sphinx RST with Furo theme

I'll see if I can start working on a pelican theme based on the new index page, as per your suggestion (unless we stick to GH announcements).

However what should we do with the already migrated pages ? We can indeed integrate them with the existing RTD site, or simply ditch them.
Maybe glyph has another idea ?

[adiroiban]

Awesome work.

I think that if sphinxwiki is migrated we can just use Sphinx.

And the Furo theme looks awesome and comes with dark/light theme ... so more awesomeness :)

---

Most of the important and still relevant content from the Trac wiki should be migrated into the main documentation at https://docs.twistedmatrix.com/en/stable/

---

Many pages from Trac wiki are no longer relevant / outdated / and only have historical value.
We can keep them (and their history) using GitHub Wikis

https://github.com/twisted/twisted/wiki/TwistedCommunity

---

For the new https://twisted.org/ what I think is missing, are the blog posts from #8.

So rather than migration the wiki pages to pelican or Sphinx, I think that it would make more sense to migrate the blog post.

Just my view :)