[Python-Dev] Move selected documentation repos to PSF BitBucket account?

[Berker Peksağ]

On Mon, Nov 24, 2014 at 6:36 PM, Donald Stufft <donald at stufft.io> wrote:
>
> On Nov 24, 2014, at 11:28 AM, Brett Cannon <brett at python.org> wrote:
>
> On Mon Nov 24 2014 at 2:25:30 AM Nick Coghlan <ncoghlan at gmail.com> wrote:
>
>>
>> That
>> outcome would be the antithesis of the PSF's overall mission,
>
>
> This might be a little controversial, but the PSF's mission should not
> influence a decision of python-dev. If we had to break a tie then yes, I
> would choose the Python-based solution. But if a superior solution existed
> and it just happened to not be written in Python I'm not going to sacrifice
> productivity and the overall health of the project just to promote an
> inferior tool because they happened to choose Python.
>
> The only reason we didn't go with Jira for our issue tracker was because of
> pressure to not go with a closed-source solution and I was promised
> volunteers from the FSF to help manage our issue tracker (which never
> materialized, BTW).
>
>
> This is really what I’m trying to do but I’m apparently not getting my point
> across very well. I want us to pick the best tool for the job regardless of
> what language it’s written in. I just so happen to think that the best tool
> for the job in this case is Github.

For peps and devguide repos GitHub would be the best tool, but not for
Doc/ and CPython itself. I also agree that GitHub's big green merge
button works well for small or middle sized projects. We can just
press the merge button for pep and devguide repos, but for Doc/ I
think using GitHub or Bitbucket would be painful.

Currently, I do the following steps for a typo fix or a minor markup change:

* Import the patch if it's provided: hg imp --no-c <url>
* If it's just a typo in the default branch, just verify it and
commit: hg commit and hg push
* If not: hg update 3.4, hg commit, hg update default, hg merge 3.4, hg push
* If it's a markup change, build the documentation locally. It'll take
2-3 minutes.

The last two steps would be look tough to follow, it's actually not. I
learned Hg when I started to send patches to CPython and learning a
couple of commands is not that hard IMO.

For GitHub or Bitbucket:

* Review the pull request and merge it via the big green merge button.
* Ask submitter to send another pull request for the 3.4 branch. If I
remember correctly, it's possible to do that from GitHub's UI, but
again opening two pull requests to fix a typo or a markup error isn't
good.
* Or cherrypick it yourself:
  - Update your local clone
  - Cherrypick the commit and push
* We can use Travis CI to build the documentation on GitHub. I don't
think this is a selling point.

I tried to fix a broken URL via the "edit" button in the PyPy repo a
couple of weeks ago. At my first try, Bitbucket opened a pull request
in my fork. It took me 10-15 minutes to open a pull request correctly.
This step would be easier on GitHub. However, I think sending an email
to docs at python.org is the easiest solution.

--Berker