Menu

#58 Migration Docutils from SourceForge to Github

Default
pending
nobody
None
5
2024-08-08
2018-02-16
No

Sourceforge is not really user friendly to report issues, propose pull-request and contribute to the project. I would like to know if it is possible to migrate Docutils to GitHub.

Discussion

1 2 3 > >> (Page 1 of 3)
  • Chris Sewell

    Chris Sewell - 2020-08-02

    Adding a +1 here. I don't mean to be rude, but it's pretty ludicrous in 2020, that such a widely used package is on sourceforge. There is literally no other python package I know of that is not using git (GitHub or GitLab) and it is a massive barrier to contribution.
    That fact that, 18 year after its first release, its still not even on its v1 release, when sphinx (IMO the main reason why docutils is still even used) is now on version 3, is pretty indicative of the lack of development on this project.
    I'm sure there are many people that want to help you improve this package, please help them to help you!

     
  • Sviatoslav Sydorenko

    I'd also like to +1 this request. These days Git is the go-to solution for starting projects and keeping them going. In fact, even I've never had to learn to use svn. I recall copying some commands back in 2012 to fetch some source but then I've never needed it again. Throughout my career I haven't met anything other then Git with a few exceptions (like perforce) on "neighbor" projects that I didn't participate in.

    And since Git became so popular, it's the first thing newbies see when they start figuring out coding in 2020. With time, the number of people who know Git (and never saw svn in their lives) and are familiar with the popular code hosting / social platforms is going to be overwhelmingly higher. Many of them could potentially contribute and help maintain this project but wouldn't want to go through all of the burden of learning a totally foreign mix of ecosystems.

    Now, besides the obvious GitHub/GitHub/BitBucket hostings that provide about the same set of the basic colaboration services (like issues/pull requests/CI), there's also others that are more open (as in they are all FOSS). Let me give you some idea about the options with some notes:

     
    👍
    2

    Last edit: Sviatoslav Sydorenko 2020-08-06
    • engelbert gruber

      Beats me ... since when is the choice of newbies an argument for going
      that way.

      The interesting thing to me is which arguments come up 😂 like the
      distributed thing which is no longer valid it seams.

      Cheers

       

      Last edit: Günter Milde 2022-06-01
      • Matthew Brett

        Matthew Brett - 2021-11-15

        Hi,

        On Mon, Nov 15, 2021 at 3:06 PM engelbert gruber via Docutils-develop
        docutils-develop@lists.sourceforge.net wrote:

        Beats me ... since when is the choice of newbies an argument for going
        that way.

        Sorry - just couldn't help it. I think you will find that a huge
        majority of experienced developers would strongly support a switch to
        Github, to support both experienced developers, and newbies.
        Fortunately for everyone, I can restrain myself from repeating the
        arguments as to why I'm sure that is the case.

        Cheers,

        Matthew

         
  • Chris Sewell

    Chris Sewell - 2020-08-06

    Thanks for the list Sviatoslav.
    Apart from personal preference, the killer reason I think GitHub though is that sphinx (IMO the main "user" of docutils) is on GitHub, and so this would allow easier cross-referencing between both projects

     
    👍
    1
  • Yves Chevallier

    Yves Chevallier - 2020-08-07

    I see much more reasons:

    • Easier search in issues
    • Allowing discussions in issues
    • Clear visible history on pull-requests
    • Easy fork/contribution on the project
    • Full GitHub actions ecosystem for continuous integration
    • and plenty more...
     
    • Takeshi KOMIYA

      Takeshi KOMIYA - 2020-08-07

      Hi folks,

      I don't have a strong opinion about migration. Indeed, I prefer to use
      GitHub and other modern platforms. But it does not mean Sourceforge
      prevents the contribution to docutils. Actually, I've posted some
      patches to this project ever. Surely, I must admit I'd needed to
      remember how to create a patch file from my git repository every time.
      But it's a minor issue to me. So I'm neutral for this topic.

      My large concern for this topic is nobody mentioned about the costs of
      migration. I think somebody should pay a cost to migrate the project
      to GitHub. Especially, I minded the cost of each maintainer. I don't
      know how they are familiar with git, GitHub, CI, and so on. I know
      openness for new contributors is very important. So I agree it is
      worth migrating to well-known platform like GitHub. But I also think
      it is important to keep the environment that main maintainers can
      works. We have to know the cost of the migration for each maintainer.
      I worry about the migration would stop or slow down more the project
      (if they need to pay costs for the new platform).

      Many thanks for continuous maintaining.

      Takeshi KOMIYA

       

      Last edit: Günter Milde 2022-06-01
  • Chris Sewell

    Chris Sewell - 2020-08-09

    Cross-posting from

    Note I have now created: https://github.com/chrisjsewell/docutils: https://github.com/sphinx-doc/sphinx/issues/8039#issuecomment-671081278
    As it states in the README, this package shows how a migration can be done in a very simple, autonomous manner:

    • migrating code, commit history (with authors) and branches using the GitHub Importer (this takes about 10 minutes),
    • migrating tickets to issues using a python script that interfaces with the SourceForge and GitHub REST APIs (this is both autonomous and idempotent and takes about 10 minutes).

    The main branch derives from the svn trunk, then here on the develop branch this README has been added and a GitHub workflow for Continuous Integration.
    I think this covers the majority of a migration?


    thanks for the reply Takeshi.
    As Inote in
    https://sourceforge.net/p/docutils/mailman/message/37077728/, unfortunately you are the only person in 2020 to have a patch ticket closed.
    I understand your viewpoint, if anyone wants to contribute money then thats great, but I think people will also pay with their time. As shown above, I'm happy to help migrate or even become a maintainer, and I'm sure I am not the only one.

     
    ❤️
    2
  • Chris Sewell

    Chris Sewell - 2020-08-09

    Cheers, well yes anything is possible, I first wanted to show that its not a particularly arduous task.

    Note I have also now added CI test coverage https://codecov.io/gh/chrisjsewell/docutils

     
    👍
    2
  • Tim Hoffmann

    Tim Hoffmann - 2021-01-24

    +1 for migrating to GitHub. I second all the benefits mentioned above. I've been moving to GitHub myself with a larger project, and it really makes a difference.

     
  • Pradyun Gedam

    Pradyun Gedam - 2021-10-06

    Hello there!

    Is there any interest amongst the maintainers/existing contributors to move away from Sourceforge?

    If folks wish to stick with Sourceforge and SVN, on principle of avoiding git because it uses hashes / proprietary software like GitHub / Microsoft owned stuff / "centralisation of open source" / something along those lines, could someone explicitly state that? (These are all things I've read on the mailing list archives for this project, but they're from a decent amount of time ago -- people are definitely entitled to changing their opinions as time passes).

    I ask becase it would be good to know -- largely because I'm more than happy to leave y'all in peace if you like this platform and want to stick with it. If the migration-related concerns are about the process of the migration rather than the idea of using git + GitHub then, please say so. I'd be happy to explore see what is possible to make that happen (both in terms of my volunteered time, seeking resources to help the process, as well as exploring ways to actually make this migration happen) -- if the currently active contributors and/or David Goodger say they're interested in migrating.

    I'm not gonna bother justifying why migrating to a more modern platform will be useful -- if existing contributors still need to be convinced about this today, then I think my time is better spent catering to my other OSS responsibilities like pip and other aspects of the Sphinx ecosystem.

     
    👍
    2
    • Matthew Brett

      Matthew Brett - 2021-10-07

      I have not contributed to Docutils, apart from some bug reports, but I
      have worked on most scientific Python projects, and have several of my
      own.

      The collaboration features of Git / Github (or Gitlab, or whatever)
      are vastly superior to the SVN / Sourceforge equivalents, and this has
      obvious consequences in terms of:

      • Increased quality of community engagement
      • Size of the developer community.

      I'd like to emphasize the first. It may not be obvious, but my
      experience is that - the clunkier and more inconvenient the tools, the
      lower the quality of the work. It's just because the person doing
      the work is spending more time fighting with the tools, and has
      consequently less thought time to devote to the quality of the code
      and their understanding of the code. By analogy, think what kind of
      code you would get if you forced your users to edit the code in
      Microsoft Word.

       
      • Chris Sewell

        Chris Sewell - 2021-10-07

        I’d note we have already been through this discussion, it seems at least once a year lol. With https://github.com/chrisjsewell/docutils I have already shown that it is really quite trivial to migrate. I get the strong impression though that the maintainers are against moving. This is absolutely their prerogative, but yeh I think the clear benefits of git vs svn are just not in question at this point

        Cheers,
        Chris

         

        Last edit: Günter Milde 2022-06-01
        • Matthew Brett

          Matthew Brett - 2021-10-07

          Yes, I know this is a recurring thread - but I was really responding to this:

          On Sun, Aug 9, 2020 at 10:28 PM engelbert gruber via Docutils-develop
          docutils-develop@lists.sourceforge.net wrote:
          [snip]

          do you know all uses of the sandbox ?
          did you see the quality of patches we get ?
          lacking everything, not even some documentation ... from the same people
          complaining the documentation of docutils is bad

          I may have misunderstood, but I took that comment to suggest that
          moving to Github was a bad idea because it would encourage more poor
          quality patches. In case that was really what Engelbert meant, I was
          arguing that it's the poor quality of the Sourceforge infrastructure,
          and SVN, that contributes to low-quality patches. Otherwise, it's a
          bit difficult to explain why Docutils would get bad patches, when that
          is not true for the various other open-source projects I'm involved
          in.

           
          • engelbert gruber

            On Thu, 7 Oct 2021 at 13:37, Matthew Brett matthewbrett@users.sourceforge.net wrote:

            Yes, I know this is a recurring thread - but I was really responding to
            this:

            On Sun, Aug 9, 2020 at 10:28 PM engelbert gruber via Docutils-develop
            docutils-develop@lists.sourceforge.net wrote:
            [snip]

            do you know all uses of the sandbox ?
            did you see the quality of patches we get ?
            lacking everything, not even some documentation ... from the same people
            complaining the documentation of docutils is bad

            I may have misunderstood, but I took that comment to suggest that
            moving to Github was a bad idea because it would encourage more poor
            quality patches. In case that was really what Engelbert meant, I was
            arguing that it's the poor quality of the Sourceforge infrastructure,
            and SVN, that contributes to low-quality patches. Otherwise, it's a
            bit difficult to explain why Docutils would get bad patches, when that
            is not true for the various other open-source projects I'm involved
            in.

            what is difficult in using the git-mirror of docutils
            and making good patches ... enlighten me
            what difference does it nmake if you send clone from the git-mirror
            to a git-master ... is there any ?

             

            Last edit: Günter Milde 2022-06-01
            • Matthew Brett

              Matthew Brett - 2021-10-13

              On Wed, Oct 13, 2021 at 11:35 PM engelbert gruber via Docutils-develop
              docutils-develop@lists.sourceforge.net wrote:

              On Thu, 7 Oct 2021 at 13:37, Matthew Brett matthewbrett@users.sourceforge.net wrote:

              Yes, I know this is a recurring thread - but I was really responding to
              this:

              On Sun, Aug 9, 2020 at 10:28 PM engelbert gruber via Docutils-develop
              docutils-develop@lists.sourceforge.net wrote:
              [snip]

              do you know all uses of the sandbox ?
              did you see the quality of patches we get ?
              lacking everything, not even some documentation ... from the same people
              complaining the documentation of docutils is bad

              I may have misunderstood, but I took that comment to suggest that
              moving to Github was a bad idea because it would encourage more poor
              quality patches. In case that was really what Engelbert meant, I was
              arguing that it's the poor quality of the Sourceforge infrastructure,
              and SVN, that contributes to low-quality patches. Otherwise, it's a
              bit difficult to explain why Docutils would get bad patches, when that
              is not true for the various other open-source projects I'm involved
              in.

              what is difficult in using the git-mirror of docutils
              and making good patches ... enlighten me
              what difference does it nmake if you send clone from the git-mirror
              to a git-master ... is there any ?

              We used to have these discussions in the early days of switching to
              Github. It was very difficult to explain to someone who hadn't used
              Git and Github, why they were such a massive improvement in workflow.
              The breakthrough would always come when, for whatever reason, the
              person who was not convinced started to use Git and Github seriously
              for code contributions and code review, at which point the objections
              just dissolved.

              So I guess I have to ask - have you not used Git or Github very much?
              I mean, have you used the system for some fairly serious piece of
              work, where you have submitted substantial Github pull requests, and
              used the Pull Request review system to review code and ask for
              changes? I'm asking because I used to use Sourceforge and SVN, a lot
              - but I would never go back to that now - and that started when I
              started to use Git and Github in earnest, first for our own projects,
              in brain imaging,, and later for all the other projects I follow and
              contribute to:

              https://github.com/matthew-brett/

              It really is like any other improvement in tooling - it takes away
              barriers between you and expressing your ideas correctly in code - and
              that means better code, from the contributors. And the code review
              systems are also a pleasure to use, making reviews easier to do, and
              easier to respond to - also making for better code - and, fairly
              quickly, better contributors.

               
              • Chris Sewell

                Chris Sewell - 2021-10-14

                and this isnt even mentioning the comple lack of Continuous Integration testing on sourceforge. with things like GH Actions and https://pre-commit.ci/, it makes it a lot easier to ensure good quality contributions, against unit tests, formatting, linting and documentation etc, significantly reducing the burden on maintainers

                 
                • engelbert gruber

                  what is so hard about the question: i really would like to know: so i
                  repeat it

                  is there a difference if you clone from the docutils-mirror on github
                  to cloning from a docutils master on github ?

                  thanks for your kindness

                   

                  Last edit: Günter Milde 2022-06-01
                  • Maarten

                    Maarten - 2021-10-19

                    It all comes down to entry barrier.
                    Even when using a docutils mirror on github to fetch the most up-to-date
                    master,
                    in order to upstream your change, you will still need to meddle with
                    mailing lists + source forge + svn.

                    Using the docutils-mirror is not even a possibility, because it is severely
                    outdated:
                    https://github.c https://github.com/docutils-mirror/docutils
                    om/docutils-mirror/docutils https://github.com/docutils-mirror/docutils
                    (last commit was 6+ years ago)

                    For me personally, the reason I think the current sourceforge project is
                    unwelcoming an github/gitlab is superior can be summed up into 3 points:

                    1. The sourceforge interface is very outdated, and unlikely to be
                      updated any time soon.
                      The method to fetch sources varies from project to project (it's very
                      inconsistent).
                      Github/gitlab are very consistent in that regard, a big clone button at
                      the home page.
                    2. Subversion is only used by dinosaurs, unwilling to adapt.
                      I don't understand why docutils hasn't made the switch to git yet.
                      Git is superior to subversion in every regard.
                      Imho, git-svn is not a substitute, but a stop gap.
                      Students aren't teached subversion anymore. It's git all the way.
                    3. Allowing only mail for sending patches raises the bar for sending
                      patches/improvements.
                      It might work for the kernel, but that project is of a total other scale
                      and has a different target audience.
                      Github/gitlab allows users to easily fork a project, make changes,
                      commit, push and send their changes upstream.
                      Mailing lists might work, but you lose a certain audience.

                    Switching to github might/will result in various/more people opening pull
                    requests.
                    Those pr's might be trivial, but some will be big/huge.
                    Are you ready to handle the possible raise of pull requests?

                    I didn't look much for other's experiences in migrating to
                    git/github/gitlab,
                    but I found this little testimonial:
                    https://twitter.com/reactos/status/1445641745685835780

                    To summarize, it's not because it's working for you (=the developer(s))
                    that it works for the community.

                    Best regards
                    Maarten

                     

                    Last edit: Günter Milde 2022-06-01
                    • Pradyun Gedam

                      Pradyun Gedam - 2021-10-19

                      Is there any interest amongst the maintainers/existing contributors to
                      move away from Sourceforge?

                      If folks wish to stick with Sourceforge and SVN, on principle of avoiding
                      git because it uses hashes / proprietary software like GitHub / Microsoft
                      owned stuff / "centralisation of open source" / something along those
                      lines, could someone explicitly state that?

                      engelbert gruber: I'd appreciate it if you could respond to these questions
                      directly.

                       

                      Last edit: Günter Milde 2022-06-01
1 2 3 > >> (Page 1 of 3)

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.