Update the migration guide

seratch · seratch · commit 95e9e040d995 · 2020-10-27T14:52:33.000+09:00
diff --git a/docs-src/v3-migration/index.rst b/docs-src/v3-migration/index.rst
@@ -2,6 +2,8 @@
 Migration Guide
 ==============================================
 
+The v2 website is live `here <https://slack.dev/python-slackclient/>`_ just like before. However, the **slackclient** project is in maintenance mode now and this **slack_sdk** project is the successor.
+
 From slackclient 2.x
 *************************************************
 
@@ -54,5 +56,9 @@ The new ``slack_sdk.web.WebClient`` doesn't rely on ``aiohttp`` internally at al
 
 If you're using ``run_async=True`` option, we highly recommend switching to ``AsyncWebClient``. ``AsyncWebClient`` is a straight-forward async HTTP client. You can expect the class properly works in the nature of ``async/await`` provided by the standard ``asyncio`` library.
 
+From slackclient 1.x
+*************************************************
+
+Refer to `the migration guide <https://github.com/slackapi/python-slack-sdk/wiki/Migrating-to-2.x>`_.
 
 .. include:: ../metadata.rst
diff --git a/docs-v2.sh b/docs-v2.sh
@@ -3,6 +3,6 @@
 sphinx-build -E -c ./docs-src-v2/_themes/slack/ -b html docs-src-v2 docs-v2 \
   && touch ./docs-v2/.nojekyll \
   && cd docs-v2/ \
-  && mv _static assets \
+  && mv _static/* assets/ \
   && find . -name '*.html' | xargs sed -i '' 's/_static/assets/'g \
   && cd -
diff --git a/docs.sh b/docs.sh
@@ -3,6 +3,6 @@
 sphinx-build -E -c ./docs-src/_themes/slack/ -b html docs-src docs \
   && touch ./docs/.nojekyll \
   && cd docs/ \
-  && mv _static assets \
+  && mv _static/* assets/ \
   && find . -name '*.html' | xargs sed -i '' 's/_static/assets/'g \
   && cd -
diff --git a/docs/about.html b/docs/about.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/faq.html b/docs/faq.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/index.html b/docs/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/installation/index.html b/docs/installation/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
diff --git a/docs/metadata.html b/docs/metadata.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/oauth/index.html b/docs/oauth/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
diff --git a/docs/real_time_messaging.html b/docs/real_time_messaging.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/search.html b/docs/search.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/v3-migration/index.html b/docs/v3-migration/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Python Slack SDK</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
@@ -190,6 +191,7 @@
                     <div class="card">
   <div class="section" id="migration-guide">
 <h1>Migration Guide<a class="headerlink" href="#migration-guide" title="Permalink to this headline">¶</a></h1>
+<p>The v2 website is live <a class="reference external" href="https://slack.dev/python-slackclient/">here</a> just like before. However, the <strong>slackclient</strong> project is in maintenance mode now and this <strong>slack_sdk</strong> project is the successor.</p>
 <div class="section" id="from-slackclient-2-x">
 <h2>From slackclient 2.x<a class="headerlink" href="#from-slackclient-2-x" title="Permalink to this headline">¶</a></h2>
 <p>There are a few changes introduced in v3.0:</p>
@@ -220,6 +222,10 @@ <h2>From slackclient 2.x<a class="headerlink" href="#from-slackclient-2-x" title
 <p>The new <code class="docutils literal notranslate"><span class="pre">slack_sdk.web.WebClient</span></code> doesn’t rely on <code class="docutils literal notranslate"><span class="pre">aiohttp</span></code> internally at all. The class provides only the synchronous way to call Web APIs. If you need a v2 compatible one, you can use <code class="docutils literal notranslate"><span class="pre">LegacyWebClient</span></code>. Apart from the name, there is no breaking change in the class.</p>
 <p>If you’re using <code class="docutils literal notranslate"><span class="pre">run_async=True</span></code> option, we highly recommend switching to <code class="docutils literal notranslate"><span class="pre">AsyncWebClient</span></code>. <code class="docutils literal notranslate"><span class="pre">AsyncWebClient</span></code> is a straight-forward async HTTP client. You can expect the class properly works in the nature of <code class="docutils literal notranslate"><span class="pre">async/await</span></code> provided by the standard <code class="docutils literal notranslate"><span class="pre">asyncio</span></code> library.</p>
 </div>
+<div class="section" id="from-slackclient-1-x">
+<h2>From slackclient 1.x<a class="headerlink" href="#from-slackclient-1-x" title="Permalink to this headline">¶</a></h2>
+<p>Refer to <a class="reference external" href="https://github.com/slackapi/python-slack-sdk/wiki/Migrating-to-2.x">the migration guide</a>.</p>
+</div>
 </div>
 
 
diff --git a/docs/web/index.html b/docs/web/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
diff --git a/docs/webhook/index.html b/docs/webhook/index.html
@@ -117,6 +117,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Python Slack SDK</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../v3-migration/index.html">Migration Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-2-x">From slackclient 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v3-migration/index.html#from-slackclient-1-x">From slackclient 1.x</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
