subversion-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Johan Corveleyn <jcor...@gmail.com>
Subject Re: Wiki migration to Confluence: test conversion ready for review
Date Fri, 23 Feb 2018 11:15:57 GMT
On Fri, Feb 23, 2018 at 10:26 AM, Julian Foad <julianfoad@apache.org> wrote:
> Johan Corveleyn wrote:
>>
>> As discussed in [1] I'm working on migrating our wiki from MoinMoin to
>> Confluence.
>>
>> After ironing out most of the big issues, I think the current "test
>> conversion" is ready for review by a larger audience. I'd like to
>> perform the final migration next Tuesday the 27th, after 21h (GMT+1),
>
>
> Excellent news!
>
>>      https://cwiki.apache.org/confluence/display/SVNTEST
>>      https://wiki.apache.org/subversion
>
>
> From a little look around, I found these:

Thanks for looking!

> (Meta) In Confluence I could not find a way to view the source. No "edit"
> option is not shown for me. The "View Source" option isn't working: instead
> of showing source, it shows an alternative rendered view.

Ah yes, I suppose that's because of lack of permissions. I've now
added you and some others now, will add some more tonight (or ping me
if you see you're missing edit permissions).
You won't be able to see the "wiki syntax" though (which is used as
import form during the migration) ... there's only a WYSIWYG editor in
Confluence now.

> MoinMoin "{{{#!wiki comment" blocks were hidden from view in MoinMion and
> are rendered as visible "note" blocks in Confluence. e.g. there is one right
> at the end of this page:
>   https://wiki.apache.org/subversion/SymmetricMerge
> (I couldn't find a way to search for them in either system. I don't know if
> we mind them being visible. I don't mind the two on this page being
> visible.)

Yes, forgot to mention that. AFAIK there is no corresponding type of
block in Confluence, so I converted those deliberately into notes,
which seemed the most fitting. I've tried also with a
"{code:languange=none|collapse=true}" block, but that didn't look very
nice (the collapsed thing is still quite big and distracting, and the
contents is then monospaced). See:

See https://confluence.atlassian.com/doc/code-block-macro-139390.html

I'll do a quick search tonight how many such comment blocks we have,
but I think there are not that many. So I think we should just make
them into notes.

> Paragraph joining (line re-wrapping) is not working: source line breaks are
> being rendered as output line breaks in Confluence. Particularly noticeable
> in e.g.
>   https://wiki.apache.org/subversion/MergeLimits
> because the source lines are short.

Indeed, noticed that yesterday too. Not sure if that's easily fixable
in an automated way during the conversion. Otherwise we'll just have
to fix manually in cwiki on the latest version (specifically
MergeLimits, and possibly some other places where it looks ugly (quite
limited I think)).

> Superscript: e.g. "10^th^ to 14^th^ June" in the first line of
> https://wiki.apache.org/subversion/Berlin2013
> (Could be fixed afterwards.)

Ack. Don't know why that one doesn't work. I think the conversion does
nothing with ^, because superscript is the same in Confluence's wiki
syntax. But I think it doens't work if it's not separated by a space
from the word before or something. Indeed, maybe we should just fix
that one manually.

> (I have just corrected the superscript mark-up in
>   https://wiki.apache.org/subversion/Aachen2017
> It was "23^^rd^^", now "23^rd^". I was able to check using search query
> "\^\^" and that was the only page with such an error.)

Okay. Anyway, as above this will probably not work anyway. Let's just
fix that on the final page after migration.

>> - We have one page which redirects to another page: SvnMergeTheory ->
>> SymmetricMerge. We could also simply omit SvnMergeTheory from the
>> conversion, and redirect the old SvnMergeTheory page on MoinMoin
>> directly to SymmetricMerge on cwiki (to avoid breaking existing
>> links). Should we do that?
>
>
> I think the best thing is to prioritize making the old site's redirection
> logic as simple as possible. Probably that is to have a "SvnMergeTheory"
> page of some sort on Confluence (a redirection within Confluence if
> possible, or whatever works), and so the old site can just redirect
> <base_url><page_name> to <confluence_url><page_name> for all
page URLs,
> whether they are redirection pages or not.

Ack. That's how it has been converted now (i.e. the confluence page
contains an SvnMergeTheory page with an intra-confluence-space
redirect to SymmetricMerge). Agreed that this is probably easiest, to
keep the redirection logic from the old site easy.

Now if you go on cwiki to SvnMergeTheory you see some "you'll be
redirected to ..." for 3 seconds or so. I believe there is also
another macro on Confluence, "alias", that just immediately transfers
you to the correct page. We can see which one we like better:
"redirect" or "alias".

> Then any future updates to the Wiki can be handled purely in Confluence, no
> matter what kind of page is involved.
>
>> - Escapes for a literal [, ], {, }, -- etc. should not be done in
>> {noformat} blocks. Will fix.
>
>
> Also long runs of dashes "-------" were reduced to just four dashes "----"
> in e.g. https://wiki.apache.org/subversion/CallGraphOfMergeCode

Good catch! I hadn't noticed that. That's probably a regex for
converting horizontal rules, which are four dashes in Confluence wiki
syntax. I suppose I should exempt "noformat" and "code" blocks from
that regex replacement. Will look into that.

> I do not feel it is important to fix all of these issues in the conversion.
> Nice of course, but not as important as getting it done.

+1

> One more thought: Having put in all this work, I wonder if most of what you
> have achieved can be re-used. (Some was manual tweaking, I know.) Several
> other Apache projects might be interested in using your updated converter to
> do an equivalent migration.

Yes, absolutely. I've been in contact with infra about this (for their
support during the migration attempts, but they also asked me to
document all of this for other projects waiting to migrate). I think
infra wants to shut down the MoinMoin instance sometime soonish,
perhaps in 6 months or so, so it's quite important to them.

I need to retrace some things though ... disorganised as I am I didn't
meticulously write it all down :-). But I'll get most of it documented
for sure. I made several changes to the java code of the UWC converter
tool (and to the confluence connector library it uses underneath), and
had a lot of fun tweaking regexes in the main converter property file.
And in the end I did also a limited number of manual fixups in the
exported moinmoin files.

> Thanks for all this work!

You're welcome :-).

-- 
Johan

Mime
View raw message