Linux PARISC architecture development
 help / color / mirror / Atom feed
From: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
To: linux-parisc@vger.kernel.org
Subject: Migrating parisc.wiki.kernel.org to RTD
Date: Fri, 11 Oct 2024 10:31:28 -0400	[thread overview]
Message-ID: <20241011-fine-bold-quail-2d60be@lemur> (raw)

Greetings:

We are trying to sunset the last few wikis that we are hosting and convert
them all to git-backed sphinx documentation. The PARISC wiki is one of the
last MediaWikis that we have, and I have prepared a migration path for you
that I hope you will find suitable.

# Preliminary build

I have the preliminary conversion build available here:

https://www.kernel.org/doc/projects/parisc/index.html

The underlying repository for it can be found here:

https://git.kernel.org/pub/scm/docs/docsko/parisc.git/

The git repository includes the entire mediawiki history (excluding media),
plus the new source tree with the conversion results.

# Multiple RTD hosting options

If you would like to switch to the new sphinx-backed site, there are multiple
ways to host it:

1. You can clone that git repository and host it on github. This would allow
   for a quick readthedocs.org integration and allow you to edit the files
   directly via the github interface. This is a very wiki-like workflow and
   would allow you to grant access to the repository to anyone with a github
   account, plus accept pull requests with modifications. Once you have
   readthedocs.org integration working, we can configure it to be under the
   docs.kernel.org domain, which will allow you to remove the ads from the
   site.

2. Continue to host it in the current location and edit it with your
   kernel.org account credentials, plus accept edits via patches sent to this
   mailing list.

# Staying with mediawiki

I believe switching to sphinx-style documentation is the right way forward,
because wikis are increasingly problematic to host due to spam and hostile
scraper bots. By switching to RTD you also gain a lot more independence in
your hosting options, as the statically generated site can be put anywhere
capable of serving files.

However, if you're absolutely sure you want to stay with MediaWiki, we can
arrange hosting with OSUOSL, but it would need to be under a non-kernel-org
domain.

# What next?

Please let me know which way you would like to proceed in the next few days,
as I am hoping to sunset our last wikis by the end of October.

Best regards,
-- 
Konstantin Ryabitsev
kernel.org

             reply	other threads:[~2024-10-11 14:31 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11 14:31 Konstantin Ryabitsev [this message]
2024-10-14 20:57 ` Migrating parisc.wiki.kernel.org to RTD Helge Deller
2024-10-15 16:32   ` Konstantin Ryabitsev
2024-10-16 15:00     ` Helge Deller
2024-10-16 15:44       ` Konstantin Ryabitsev
2024-10-21 20:17 ` Migration of " Helge Deller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241011-fine-bold-quail-2d60be@lemur \
    --to=konstantin@linuxfoundation.org \
    --cc=linux-parisc@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox