rename slave to worker #291

levlaz · 2017-11-01T07:38:49Z

This PR renames all references from "slave" to "worker".

It fixes all broken URLs related to buildbot.

In addition, I added:

linkcheck_anchors_ignore = [
    # match any anchor that starts with a '/' since this is an invalid HTML anchor
    '\/.*',
]

to the conf.py file. The link checker was complaining that things like /console were invalid anchors. This is true since these are dynamically generated and not valid HTML anchors.

fix #290

levlaz · 2017-11-01T07:39:42Z

buildworker.rst

@@ -326,7 +326,7 @@ Security Considerations
 -----------------------

 We only allow builds to be triggered against commits to the CPython repository,
-or committer-initiated branches hosted on hg.python.org.  This means that the
+or committer-initiated branches hosted on `https://github.com/python/cpython`_.  This means that the


I made an assumption that this link should be updated to reference GitHub since that is where the code is now stored.

per brief discussion in #python-dev with berker.

zware

Looking good, but a few comments:

zware · 2017-11-01T15:31:32Z

buildbots.rst

@@ -209,7 +209,7 @@ Custom builders
 When working on a platform-specific issue, you may want to test your changes on
 the buildbot fleet rather than just on Travis and AppVeyor.  To do so, you can
 make use of the `custom builders
-<http://buildbot.python.org/all/waterfall?category=custom.stable&category=custom.unstable>`_.
+<http://buildbot.python.org/all/#/waterfall?category=custom.stable&category=custom.unstable>`_.


This whole link doesn't really work anymore. We could try http://buildbot.python.org/all/#/builders?tags=custom.unstable&tags=custom.stable instead.

zware · 2017-11-01T15:31:32Z

buildworker.rst


-Running a buildslave
-====================
+Running a buildworker


"buildworker" doesn't really fit the terminology now used by Buildbot and doesn't flow as easily as "buildslave", either. Just "worker" fits Buildbot's new terminology, with "buildbot worker" for disambiguation where necessary. This applies pretty much everywhere in this PR, and it's a judgement call as to whether each instance needs disambiguation.

zware · 2017-11-01T15:31:32Z

buildworker.rst

@@ -24,18 +24,18 @@ mailing list.  This mailing list is also the place to contact if you want to
 contribute a buildbot but have questions.

 As for what kind of buildbot to run...take a look at our `current fleet
-<http://buildbot.python.org/all/buildslaves>`_.  Pretty much anything that isn't
+<http://buildbot.python.org/all/#/builders>`_.  Pretty much anything that isn't


This should be workers rather than builders.

zware · 2017-11-01T15:31:32Z

buildworker.rst

 on that list would be interesting: different Linux/UNIX distributions,
 different versions of the various OSes, other OSes if you or someone are
 prepared to make the test suite actually pass on that new OS.  Even if you only
 want to run an OS that's already on our list there may be utility in setting it
-up: we also need to build and test python under various alternate build
-configurations.  Post to the mailing list and talk about what you'd like to
+up. We also need to build and test python under various alternate build


I agree that the colon isn't quite right, but I'd rather just replace it with a semicolon than a full stop. And the space doesn't need to be removed before Post.

</nitpick>

zware · 2017-11-01T15:31:32Z

buildworker.rst

@@ -82,40 +82,40 @@ For Mac:
    * Log in as the buildbot user.
    * Install either the Python 2.7 bundle from python.org [#]_, or pip.
    * Open a terminal window.
-    * Execute ``pip install buildbot-slave``.
+    * Execute ``pip install buildbot-worker``.

 For Windows:

    * Create a buildbot user as a "standard" user.
    * Install the latest version of Python 2.7 from python.org.


This no longer needs to specify 2.7; we can use any version we want now :)

This series of instructions was a tad bit confusing so I specified that the last step is only necessary if using pip.

I'm a little lost on your comment here. My comment was just that we can remove "2.7" from this line :)

zware · 2017-11-01T15:31:32Z

buildworker.rst

      ``python.exe`` is not added to ``PATH`` by default, making the
      ``python`` command accessible is left as an exercise for the user).

 In a terminal window for the buildbot user, issue the following commands (you
 can put the ``buildarea`` wherever you want to)::

    mkdir buildarea
-    buildslave create-slave buildarea buildbot.python.org:9020 slavename slavepasswd
+    buildworker create-worker buildarea buildbot.python.org:9020 workername workerpasswd


s/buildworker/buildbot-worker/

This applies everywhere the buildslave command was used.

zware · 2017-11-01T15:31:32Z

buildworker.rst

 down for an unexpectedly long time, please ping the `python-buildbots
 <https://mail.python.org/mailman/listinfo/python-buildbots>`_ list to
 request that the master be restarted.

-Latent slaves should also be updated periodically to include operating system
+Latent worker should also be updated periodically to include operating system


s/worker/workers/

zware · 2017-11-01T15:31:32Z

buildworker.rst

 down for an unexpectedly long time, please ping the `python-buildbots
 <https://mail.python.org/mailman/listinfo/python-buildbots>`_ list to
 request that the master be restarted.

-Latent slaves should also be updated periodically to include operating system
+Latent worker should also be updated periodically to include operating system
 or other software updates, but when do do such maintenance is largely up to you


s/do do/to do/ (please, I know it's not your typo :))

levlaz · 2017-11-02T02:01:42Z

Thank you for the thorough review @zware. I made all the requested changes and used my best judgement when switching between "buildbot worker" and "worker".

ezio-melotti · 2017-11-02T02:28:46Z

buildworker.rst

    * Open a terminal window.
-    * Execute ``pip install buildbot-slave``.
+    * If using pip; execute ``pip install buildbot-worker``.


I would structure this as:

Create a buildbot user ...

Log in as the buildbot user

Install buildbot, either from python.org or by running pip install buildbot-worker

Thanks, this is much clearer.

ezio-melotti · 2017-11-02T02:28:46Z

conf.py

+linkcheck_anchors_ignore = [
+    # match any anchor that starts with a '/' since this is an invalid HTML anchor
+    '\/.*',
+]


Missing newline at the end of the file.

Ugh, even my linter yelled at me and I ignored it. Thank you :)

levlaz · 2017-11-09T04:46:00Z

Hey @zware I made all of the changes that you requested. Is there anything else I can do for this PR?

zware

Just a couple of minor fixes to go :)

zware · 2017-11-09T04:53:01Z

buildworker.rst

-    * Install either the Python 2.7 bundle from python.org [#]_, or pip.
-    * Open a terminal window.
-    * Execute ``pip install buildbot-slave``.
+    * Install the buildbot worker, either from python.org [#]_ or by running ``pip install buildbot-worker``.


This isn't quite right; buildbot-worker is not available from python.org. I'd say just take out everything between worker, and by.

zware · 2017-11-09T04:53:01Z

buildworker.rst

@@ -82,40 +82,40 @@ For Mac:
    * Log in as the buildbot user.
    * Install either the Python 2.7 bundle from python.org [#]_, or pip.
    * Open a terminal window.
-    * Execute ``pip install buildbot-slave``.
+    * Execute ``pip install buildbot-worker``.

 For Windows:

    * Create a buildbot user as a "standard" user.
    * Install the latest version of Python 2.7 from python.org.


I'm a little lost on your comment here. My comment was just that we can remove "2.7" from this line :)

levlaz · 2017-11-09T05:07:49Z

Thank you @zware! I think we are all set. Just pushed a change which makes the MacOS section (hopefully) crystal clear.

rename slave to builder

Loading status checks…

50e653d

fix #290

the-knights-who-say-ni added the CLA signed label Nov 1, 2017

levlaz reviewed Nov 1, 2017

View changes

levlaz added 3 commits Nov 1, 2017

fix GitHub link formatting

Loading status checks…

5939cfa

update wording about GitHub

Loading status checks…

3d474ee

per brief discussion in #python-dev with berker.

fix punctuation

Loading status checks…

bf4ef83

zware requested changes Nov 1, 2017

View changes

Clean up based on feedback from zware

Loading status checks…

045dc14

ezio-melotti reviewed Nov 2, 2017

View changes

levlaz added 3 commits Nov 2, 2017

add newline, clear up MacOS buildbot worker doc

Loading status checks…

b851f16

add newline to conf.py

Loading status checks…

a04ef78

re-add refernce to footnote

Loading status checks…

1f19863

zware requested changes Nov 9, 2017

View changes

clean up mac instructions

Loading status checks…

58aadf7

zware approved these changes Nov 9, 2017

View changes

zware merged commit 766ccd6 into python:master Nov 9, 2017
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

python / devguide

rename slave to worker #291

rename slave to worker #291

levlaz commented Nov 1, 2017

This comment has been minimized.

zware left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

levlaz commented Nov 2, 2017

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

levlaz commented Nov 9, 2017

zware left a comment

This comment has been minimized.

This comment has been minimized.

levlaz commented Nov 9, 2017

python / devguide

Sponsor python/devguide

Join GitHub today

GitHub is where the world builds software

rename slave to worker #291

rename slave to worker #291

Conversation

levlaz commented Nov 1, 2017

This comment has been minimized.

levlaz Nov 1, 2017 Author Contributor

zware left a comment

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

levlaz Nov 2, 2017 Author Contributor

This comment has been minimized.

zware Nov 9, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

This comment has been minimized.

zware Nov 1, 2017 Member

levlaz commented Nov 2, 2017

This comment has been minimized.

ezio-melotti Nov 2, 2017 Member

This comment has been minimized.

levlaz Nov 2, 2017 Author Contributor

This comment has been minimized.

ezio-melotti Nov 2, 2017 Member

This comment has been minimized.

levlaz Nov 2, 2017 Author Contributor

levlaz commented Nov 9, 2017

zware left a comment

This comment has been minimized.

zware Nov 9, 2017 Member

This comment has been minimized.

zware Nov 9, 2017 Member

levlaz commented Nov 9, 2017

Essential cookies

Always active

Analytics cookies

levlaz Nov 1, 2017
Author Contributor

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

levlaz Nov 2, 2017
Author Contributor

zware Nov 9, 2017
Member

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

zware Nov 1, 2017
Member

ezio-melotti Nov 2, 2017
Member

levlaz Nov 2, 2017
Author Contributor

ezio-melotti Nov 2, 2017
Member

levlaz Nov 2, 2017
Author Contributor

zware Nov 9, 2017
Member

zware Nov 9, 2017
Member