[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #5344: Add a page that addresses migrating from Traffic Ops API v1 for each endpoint

[GitBox <gi...@apache.org>]

zrhoffman commented on a change in pull request #5344:
URL: https://github.com/apache/trafficcontrol/pull/5344#discussion_r535749950



##########
File path: docs/source/api/migrating-from-v1.rst
##########
@@ -0,0 +1,671 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+..     http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-migrating:
+
+*********************
+Migrating from API V1
+*********************
+
+Versions 1.0, 1.1, 1.2, 1.3, 1.4, and 1.5 of the :ref:`to-api` have been deprecated since Apache Traffic Control version 4.0.0 and will be removed in Apache Traffic Control version 6.0.0. Any remaining users of 1.x endpoints of the Traffic Ops API are advised to upgrade to API version 3.0.
+
+Upgrading your Traffic Ops client
+=================================
+
+The easiest way to switch to a new API version is to use the latest version of a Traffic Ops client.
+
+Golang
+------
+
+If you are using the **github.com/apache/trafficcontrol/traffic_ops/client** package, use the |to-client-library-godoc|_ package instead.
+
+.. |to-client-library-godoc| replace:: **github.com/apache/trafficcontrol/traffic_ops/v3-client**
+.. _to-client-library-godoc: https://godoc.org/github.com/apache/trafficcontrol/traffic_ops/v3-client
+
+Python
+______
+
+Update to a newer version of the `Apache-TrafficControl <https://pypi.org/project/Apache-TrafficControl>`_ package.

Review comment:
       So we're allowed to publish to PyPI but not allowed to talk about it? That makes 0 sense, and from a cursory search, I have found 7 Apache projects that recommend installing their Python module from PyPI on their main README:
   
   * [apache/airflow](/apache/airflow)
   * [apache/dubbo-python](/apache/dubbo-python)
   * [apache/dubbo-python2](/apache/dubbo-python2)
   * [apache/ignite-python-thin-client](/apache/ignite-python-thin-client)
   * [apache/predictionio-sdk-python](/apache/predictionio-sdk-python)
   * [apache/rocketmq-client-python](/apache/rocketmq-client-python)
   * [apache/skywalking-python](/apache/skywalking-python)
   
   If there's a concrete Apache page that explicitly says *Don't tell users to download from PyPI*, that's one thing. Otherwise, I'd rather just link the package since several other Apache projects already tell users to download their module from PyPI.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org