Migrate the docs from Wiki to forge #25

New issue

Open

opened 2026-07-07 10:15:23 +00:00 by kashyapc · 0 comments

kashyapc commented

2026-07-07 10:15:23 +00:00

Owner

What?

Move all the documentation from the wiki (https://fedoraproject.org/wiki/Architectures/RISC-V) to forge (https://forge.fedoraproject.org/riscv), and publish it to docs.fp.o.

Why?

Not many people enjoy writing in MediaWiki format, it's a bit clumsy, docs drift away easily. We use the Wiki because it's there, and it kinda works. Moving a Git-based workflow it provides a way to do peer review with an MR-based workflow, is accessible offline, and Markdown/rST are easier to work with.

Potential idea

From a chat with the Fedora Docs folks, the sources for these docs could exist in our forge (e.g. https://forge.fedoraproject.org/riscv/docs) and they could create a docs.fp.o/riscv/ for simplicity.

There's also this Fedora Docs, if we want to try it : https://gitlab.com/fedora/docs/templates/fedora-docs-template. But it's in AsciiDoc, though, a bit of an annoying format to work with.

Thoughts / TODO

Based on a discussion on Fedora RISC-V Matrix channel a few months ago

When moving, bear in mind, that this requires a big editorial effort to clean up the docs.
Write up a small template site to get an idea of how it will look like
Think about the process to contribute to it
Access: how do you get the equivalent to a wiki account?
Markup format: it would be nice if it is reStructuredText (rST) and Sphinx or some kind of Markdown-based workflow. rST + Sphinx is widely used by many open source projects (including upstream kernel)

### What? Move all the documentation from the wiki (https://fedoraproject.org/wiki/Architectures/RISC-V) to forge (https://forge.fedoraproject.org/riscv), and publish it to docs.fp.o. ### Why? Not many people enjoy writing in MediaWiki format, it's a bit clumsy, docs drift away easily. We use the Wiki because it's there, and it kinda works. Moving a Git-based workflow it provides a way to do peer review with an MR-based workflow, is accessible offline, and Markdown/rST are easier to work with. ### Potential idea From a chat with the Fedora Docs folks, the sources for these docs could exist in our forge (e.g. https://forge.fedoraproject.org/riscv/docs) and they could create a docs.fp.o/riscv/ for simplicity. There's also this Fedora Docs, if we want to try it : https://gitlab.com/fedora/docs/templates/fedora-docs-template. But it's in AsciiDoc, though, a bit of an annoying format to work with. ### Thoughts / TODO Based on a discussion on Fedora RISC-V Matrix channel a few months ago - When moving, bear in mind, that this requires a big editorial effort to clean up the docs. - Write up a small template site to get an idea of how it will look like - Think about the process to contribute to it - Access: how do you get the equivalent to a wiki account? - Markup format: it would be nice if it is reStructuredText (rST) and Sphinx or some kind of Markdown-based workflow. rST + Sphinx is widely used by many open source projects (including upstream kernel)

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

riscv/planning#25

No description provided.

Rows
Columns