Migrating x.org wiki to GitLab
Zach Reizner
zach297 at gmail.com
Sat Nov 17 09:52:29 UTC 2018
On Wed, Nov 14, 2018 at 3:38 PM Eric Anholt <eric at anholt.net> wrote:
>
> Zach <zach297 at gmail.com> writes:
>
> > Hello X.Org Developers,
> >
> > I have been working on migrating the x.org/wiki/ to GitLab pages. The
> > tracking issue is at
> > https://gitlab.freedesktop.org/freedesktop/freedesktop/issues/80 and
> > the current development branch is at
> > https://gitlab.freedesktop.org/zachr/xorg-wiki/tree/hugo. You can see
> > the pages rendered from ToT at
> > https://zachr.pages.freedesktop.org/xorg-wiki/.
> >
> > As part of the migration process, I have converted the markdown flavor
> > from ikiwiki to hugo using a custom script. Not everything in the old
> > flavor can be replicated practically in the new flavor, so there will
> > be junk in the converted pages, unfortunately. As we identify which of
> > the approximately 1000 converted pages is actually seen by human eyes,
> > we will fix the glitches.
> >
> > Additionally, I have designed a new theme which is aiming for
> > accessibility and clarity. What you see on there isn't final, but is
> > hopefully good enough.
> >
> > When the migration is done, the primary advantage will be much more
> > streamlined edits by the community. Thanks to the hugo static site
> > generator, editors will be able to render locally in under 1 second to
> > verify that their change renders nicely. Getting their change
> > published is a simple merge request, and then the site automatically
> > gets rebuilt and published by GitLab. If all goes well, the entire
> > process can be done in 5 minutes.
> >
> > Please let me know if you have any objections or questions about the migration.
>
> I'd love to see ikiwiki go away and have people be able to edit the wiki
> inside gitlab (as well as work from a local clone). Does your
> conversion let people do things from a web ui, or do they have to do
> offline generation to test things?
There isn't any web UI, besides the generic gitlab editor for files in
a repo. The gitlab-ci should automatically regenerate pages in any
forked repo, but that would be clunky in comparison to cloning and
generating locally.
More information about the xorg-devel
mailing list