Status of doc migration to Git
| From: | Peter Cowburn | Date: | Wed, 19 Mar 2014 10:12:57 +0000 |
| Subject: | Status of doc migration to Git | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969384878@lists.php.net to get a copy of this message | ||
Hi folks,
It has been a while since moving to Git was last discussed on this list.
I'd like to give the idea another gentle poke to see where we're at and
where we want to get to.
There are tonnes of really good reasons to move the docs to Git, that I
don't really wish to discuss here (they're hopefully all pretty obvious
anyway). I'm more interested in what is holding us back.
From earlier discussions, if memory serves, the stumbling/pain points
seemed to be:
- Modules (how to make doc-en?)
- Translation statuses (how to make $Revision$ work)
- Online Editor (make me work with Git)
- Lots of little scripts will need "fixing"
None of those are insurmountable, that I can see.
- Modules; we can create "wrapper" Git repos with submodules to offer the
same setup if we really want to. I'd argue that it's probably good to
ignore this anyway since it's easy enough to separately check out doc-base
and whatever language(s) you want.
- Translation statuses; we could probably insert the Git hash in place of
the SVN revision number, that doesn't show how out-of-date the file is
though. Is there some other convenient way to replace the usage of
EN-Revision values, with Git? How do translators use this, if at all? Do
you?
- Online Editor; a lot of work went in to the GIT_READY branch, what's the
status of that?
- Scripts; of course there's probably a million places where we need to
replace "svn.php.net" with "git.php.net", in build scripts and such like.
That's more of a mole hill than a mountain though, right?
To be frank, I'd rather have the documentation sources on Git now even if
there are things that might be temporarily broken (that's probably good
motivation to fix small issues), than sit back on our laurels, tootling
along with SVN.
Thoughts? Did I miss something that *is* huge and insurmountable?
Cheers,
Peter