Google Code to GitHub migration plans

Steven Bethard

unread,

Apr 7, 2015, 4:57:54 PM4/7/15

to cleartk-d...@googlegroups.com

I'm working on migrating ClearTK from Google Code to GitHub. I've
created us a ClearTK organization.

You can see the migrated code here:

https://github.com/ClearTK/cleartk

You can see the (barely started) wiki migration here:

http://ClearTK.github.io/cleartk/

Remaining tasks:

* If you are a regular committer to ClearTK, please send me your
GitHub username so that I can add you to the organization.

* We need to migrate the issues from Google Code. The recommended
approach, https://code.google.com/p/support-tools/wiki/IssueExporterTool,
does a pretty crappy job of it (e.g. lots of empty comments when
issues were closed by revisions). I don't see any better option
though...

* We need to migrate the Google Code wiki to the GitHub gh-pages
branch (in Jekyll format)

* We need to fix the Maven configuration to point to GitHub instead of
Google Code

If you'd like to volunteer to help out with any of these issues,
please let me know so that we can coordinate.

Steve

Steven Bethard

unread,

Apr 16, 2015, 7:40:11 AM4/16/15

to cleartk-d...@googlegroups.com

On Tue, Apr 7, 2015 at 3:57 PM, Steven Bethard <steven....@gmail.com> wrote:
> I'm working on migrating ClearTK from Google Code to GitHub. I've
> created us a ClearTK organization.
>
> You can see the migrated code here:
>
> https://github.com/ClearTK/cleartk
>
> You can see the (barely started) wiki migration here:
>
> http://ClearTK.github.io/cleartk/
>
> Remaining tasks:
>
> * If you are a regular committer to ClearTK, please send me your
> GitHub username so that I can add you to the organization.

I still need these.

> * We need to migrate the issues from Google Code. The recommended
> approach, https://code.google.com/p/support-tools/wiki/IssueExporterTool,
> does a pretty crappy job of it (e.g. lots of empty comments when
> issues were closed by revisions). I don't see any better option
> though...

I've done this.

> * We need to migrate the Google Code wiki to the GitHub gh-pages
> branch (in Jekyll format)

We still need to do this.

> * We need to fix the Maven configuration to point to GitHub instead of
> Google Code

I've done this.

Steve

Richard Eckart de Castilho

unread,

Apr 16, 2015, 8:15:58 AM4/16/15

to cleartk-d...@googlegroups.com

On 16.04.2015, at 13:40, Steven Bethard <steven....@gmail.com> wrote:

>> * We need to migrate the Google Code wiki to the GitHub gh-pages
>> branch (in Jekyll format)
>
> We still need to do this.

Just some thoughts on this one.

I personally don't like documentation in wikis anymore. It was
convenient at Google Code, but it has the problem that the documentation
is not versioned along with the code. It is difficult to get old
documentation when using an old version of a project.

I like the approach taken in UIMA more, where documentation is just
a sub-module in the Maven structure and that I what I'm pushing
projects that I am working on towards now.

UIMA uses DocBook and I also tried that for other projects. The
problem is, that DocBook can only properly be maintained using a
commercial XML editor - everything else is a pain. This basically
meant that I was the only one writing documentation.

Recently, I have found asciidoc (and the maven-asciidoctor-plugin)
to be a great alternative for maintaining versioned project
documentation. asciidoc is a lightweight markdown syntax similar
to the ones we know from wikis and in my opinion well suited for
documentation.

I also have the impression that asciidoc is being adopted by some
major projects or at least that the are many fans that speak out loudly ;)
One source says: "most notably Pivotal (Spring, Groovy), RedHat
(OpenShift, JBoss) and the Git project" [1]

Google Code wiki markup is slightly different from asciidoc markup,
but sufficiently similar that one can just rename the files and
something comes out. Then fixing tables, source blocks, and references
to images/screenshots were the main stuff I had to do.

Maybe this is an interesting approach for you too.

Cheers,

-- Richard

P.S.: There is some support for asciidoc in the GitHub online editor
component, unfortunately not yet in Jekyll.

- http://asciidoctor.org
- http://asciidoctor.org/docs/asciidoctor-maven-plugin/
- https://github.com/asciidoctor/jekyll-asciidoc
[1] https://plus.google.com/114112334290393746697/posts/GynW8kTV1G1

Lee Becker

unread,

Apr 16, 2015, 10:34:42 AM4/16/15

to cleartk-d...@googlegroups.com

On Thu, Apr 16, 2015 at 6:15 AM, Richard Eckart de Castilho <richard...@gmail.com> wrote:

I like the approach taken in UIMA more, where documentation is just
a sub-module in the Maven structure and that I what I'm pushing
projects that I am working on towards now.

UIMA uses DocBook and I also tried that for other projects. The
problem is, that DocBook can only properly be maintained using a
commercial XML editor - everything else is a pain. This basically
meant that I was the only one writing documentation.

Recently, I have found asciidoc (and the maven-asciidoctor-plugin)
to be a great alternative for maintaining versioned project
documentation. asciidoc is a lightweight markdown syntax similar
to the ones we know from wikis and in my opinion well suited for
documentation.

This is a good idea. I wonder if we could get away with just using Github style markdown in a documentation directory.

Steven Bethard

unread,

Apr 17, 2015, 7:17:00 AM4/17/15

to cleartk-d...@googlegroups.com

On Thu, Apr 16, 2015 at 7:15 AM, Richard Eckart de Castilho
<richard...@gmail.com> wrote:
> On 16.04.2015, at 13:40, Steven Bethard <steven....@gmail.com> wrote:
>
>>> * We need to migrate the Google Code wiki to the GitHub gh-pages
>>> branch (in Jekyll format)
>>
>> We still need to do this.
>
> Just some thoughts on this one.
>
> I personally don't like documentation in wikis anymore. It was
> convenient at Google Code, but it has the problem that the documentation
> is not versioned along with the code. It is difficult to get old
> documentation when using an old version of a project.
>
> I like the approach taken in UIMA more, where documentation is just
> a sub-module in the Maven structure and that I what I'm pushing
> projects that I am working on towards now.

So what do you do on GitHub? How do you merge that sub-module, which
is presumably on master, to the gh-pages branch? Or do you host your
docs somewhere other than github.io?

Steve

Richard Eckart de Castilho

unread,

Apr 17, 2015, 7:51:00 AM4/17/15

to cleartk-d...@googlegroups.com

For JavaDoc and the HTML pages generated from asciidoc, I'm planning
to copy them to sub-folders in the gh-pages branch when releases
are made. I plan to have one sub-folder for each release containing
the documentation for that release. My understanding is that gh-pages
basically serves static HTML (partially pre-generated from Jekyll templates),
so I would expect this works. It's similar to what we all have done
with the JavaDoc in subversion.

Cheers,

-- Richard

Philip Ogren

unread,

Apr 21, 2015, 8:34:22 AM4/21/15

to cleartk-d...@googlegroups.com

Hi Steve,

Thank you for your efforts. Apologies for the delayed response. My github user is 'pogren'.

Thanks,

Philip

--
You received this message because you are subscribed to the Google Groups "cleartk-developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cleartk-develop...@googlegroups.com.
To post to this group, send email to cleartk-d...@googlegroups.com.
Visit this group at http://groups.google.com/group/cleartk-developers.
For more options, visit https://groups.google.com/d/optout.

Steven Bethard

unread,

May 1, 2015, 3:20:12 PM5/1/15

to cleartk-d...@googlegroups.com

On Thu, Apr 16, 2015 at 7:40 AM, Steven Bethard
<steven....@gmail.com> wrote:
> On Tue, Apr 7, 2015 at 3:57 PM, Steven Bethard <steven....@gmail.com> wrote:
>> * We need to migrate the Google Code wiki to the GitHub gh-pages
>> branch (in Jekyll format)
>
> We still need to do this.

Steven Bethard

unread,

May 4, 2015, 5:08:01 PM5/4/15

to cleartk-d...@googlegroups.com

On Fri, May 1, 2015 at 3:20 PM, Steven Bethard <steven....@gmail.com> wrote:
> Todo:
>
> https://code.google.com/p/cleartk/wiki/UserFAQ

Moved to http://cleartk.github.io/cleartk/docs/user_faq.html

> https://code.google.com/p/cleartk/wiki/ClearTKML

Moved to http://cleartk.github.io/cleartk/docs/cleartk_ml.html

> https://code.google.com/p/cleartk/wiki/ClearTKTimeML

Moved to http://cleartk.github.io/cleartk/docs/cleartk_timeml.html

> https://code.google.com/p/cleartk/wiki/TutorialPartOfSpeechClassifier
> https://code.google.com/p/cleartk/wiki/TutorialNamedEntityChunkingClassifier
> https://code.google.com/p/cleartk/wiki/TutorialFeatureExtraction
> https://code.google.com/p/cleartk/wiki/TutorialTrainableFeatureExtraction

Steven Bethard

unread,

May 6, 2015, 4:51:01 PM5/6/15

to cleartk-d...@googlegroups.com

On Mon, May 4, 2015 at 5:08 PM, Steven Bethard <steven....@gmail.com> wrote:
> On Fri, May 1, 2015 at 3:20 PM, Steven Bethard <steven....@gmail.com> wrote:
>> Todo:

>> https://code.google.com/p/cleartk/wiki/TutorialPartOfSpeechClassifier

Moved to http://cleartk.github.io/cleartk/docs/tutorial/sequence_classifier.html

>> https://code.google.com/p/cleartk/wiki/TutorialNamedEntityChunkingClassifier

Moved to http://cleartk.github.io/cleartk/docs/tutorial/chunking_classifier.html

>> https://code.google.com/p/cleartk/wiki/TutorialFeatureExtraction

Moved to http://cleartk.github.io/cleartk/docs/tutorial/feature_extraction.html

>> https://code.google.com/p/cleartk/wiki/TutorialTrainableFeatureExtraction

Moved to http://cleartk.github.io/cleartk/docs/tutorial/trainable_feature_extraction.html

I believe that means all the user-facing documentation is complete,
and the only things remaining are the stuff for contributors:

>> https://code.google.com/p/cleartk/wiki/DeveloperSetup
>> https://code.google.com/p/cleartk/wiki/DeveloperFAQ
>> https://code.google.com/p/cleartk/wiki/MailingLists

Steve

Steven Bethard

unread,

May 8, 2015, 11:42:31 AM5/8/15

to cleartk-d...@googlegroups.com

On Wed, May 6, 2015 at 4:51 PM, Steven Bethard <steven....@gmail.com> wrote:
> I believe that means all the user-facing documentation is complete,
> and the only things remaining are the stuff for contributors:
>
>>> https://code.google.com/p/cleartk/wiki/DeveloperSetup

Moved to http://cleartk.github.io/cleartk/docs/contributor/contributor_setup.html

>>> https://code.google.com/p/cleartk/wiki/DeveloperFAQ
>>> https://code.google.com/p/cleartk/wiki/MailingLists

Merged, updated to reflect GitHub development, and moved to
http://cleartk.github.io/cleartk/docs/contributor/contributor_faq.html

I believe that takes care of everything I intend to move over, so I've
also updated the front page of https://code.google.com/p/cleartk/ to
point to http://cleartk.github.io/cleartk/.

I haven't actually used the Project Moved button on Google Code, since
that [apparently makes it impossible to access the data
there](https://github.com/gc-migration/howto#do-not-mark-the-projects-as-moved-on-google-code),
which we'll still need when someone notices something that I missed
during the move.

Steve

Reply all

Reply to author

Forward