Update the v2 documents

Author: seratch

docs-src-v2/index.rst

@@ -10,9 +10,19 @@
    changelog
    about
 
+Important Notice
+*********************
+
+The `slackclient <https://pypi.org/project/slackclient/>`_ PyPI project is in maintenance mode now and `slack-sdk <https://pypi.org/project/slack-sdk/>`_ project is the successor. The v3 SDK provides more functionalities such as Socket Mode, OAuth flow module, SCIM API, Audit Logs API, better asyncio support, retry hanlders, and many more.
+
+Refer to `the migration guide <https://slack.dev/python-slack-sdk/v3-migration/index.html#from-slackclient-2-x>`_ to learn how to smoothly migrate your existing code.
+
+--------
+
 ==============================================
 |product_name|
 ==============================================
+
 Slack's APIs allow anyone to build full featured integrations that extend
 and expand the capabilities of your Slack workspace. These APIs allow you
 to build applications that interact with Slack just like the people on your

docs-v2/about.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/auth.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#single-workspace-install">Single Workspace Install</a></li>

docs-v2/basic_usage.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/changelog.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/conversations.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/faq.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/genindex.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul>
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

docs-v2/index.html

@@ -6,7 +6,7 @@
       content="text/html; charset=utf-8"
     />
 
-    <title>slackclient (Legacy Python Slack SDK) &mdash; slackclient (Legacy Python Slack SDK)</title>
+    <title>Important Notice &mdash; slackclient (Legacy Python Slack SDK)</title>
 
     <!-- Google Tag Manager -->
     <script>
@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>
@@ -241,12 +241,17 @@
 
         <!-- Body Content -->
         <div class="col span_3_of_4">
-          <!-- <div class="section-title">slackclient (Legacy Python Slack SDK)</div> -->
+          <!-- <div class="section-title">Important Notice</div> -->
           <div class="card">
   <div class="toctree-wrapper compound">
 </div>
+<div class="section" id="important-notice">
+<h1>Important Notice<a class="headerlink" href="#important-notice" title="Permalink to this headline">¶</a></h1>
+<p>The <a class="reference external" href="https://pypi.org/project/slackclient/">slackclient</a> PyPI project is in maintenance mode now and <a class="reference external" href="https://pypi.org/project/slack-sdk/">slack-sdk</a> project is the successor. The v3 SDK provides more functionalities such as Socket Mode, OAuth flow module, SCIM API, Audit Logs API, better asyncio support, retry hanlders, and many more.</p>
+<p>Refer to <a class="reference external" href="https://slack.dev/python-slack-sdk/v3-migration/index.html#from-slackclient-2-x">the migration guide</a> to learn how to smoothly migrate your existing code.</p>
+<hr class="docutils" />
 <div class="section" id="product-name">
-<h1>slackclient (Legacy Python Slack SDK)<a class="headerlink" href="#product-name" title="Permalink to this headline">¶</a></h1>
+<h2>slackclient (Legacy Python Slack SDK)<a class="headerlink" href="#product-name" title="Permalink to this headline">¶</a></h2>
 <p>Slack’s APIs allow anyone to build full featured integrations that extend
 and expand the capabilities of your Slack workspace. These APIs allow you
 to build applications that interact with Slack just like the people on your
@@ -257,14 +262,16 @@ <h1>slackclient (Legacy Python Slack SDK)<a class="headerlink" href="#product-na
 Python apps as quickly as possible. The current version, 2.0, is
 built for Python 3.6 and higher – if you need to target Python 2.x, you might
 consider using v1 of the SDK.</p>
+</div>
+</div>
 <div class="section" id="slack-platform-basics">
-<h2>Slack Platform Basics<a class="headerlink" href="#slack-platform-basics" title="Permalink to this headline">¶</a></h2>
+<h1>Slack Platform Basics<a class="headerlink" href="#slack-platform-basics" title="Permalink to this headline">¶</a></h1>
 <p>If you’re new to the Slack platform, we have a general purpose <a class="reference external" href="https://api.slack.com/start">guide for building apps</a> that isn’t specific to any language or framework. It’s a great place to learn all about the concepts that go into building a great Slack app.</p>
 <p>Before you get started building on the Slack platform, you need to <a class="reference external" href="https://api.slack.com/apps/new">set up your app’s configuration</a>. This is where you define things like your app’s permissions and the endpoints that Slack should use for interacting with the backend you will build with Python.</p>
 <p>The app configuration page is also where you will acquire the OAuth token you will use to call Slack’s APIs. Treat this token with care, just like you would a password, because it has access to workspace and can potentially read and write data to and from it.</p>
 </div>
 <div class="section" id="installation">
-<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
 <p>We recommend using <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> to install slackclient (Legacy Python Slack SDK)</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install slackclient
 </pre></div>
@@ -294,13 +301,12 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <p>It’s also good to try on the Python REPL.</p>
 </div>
 <div class="section" id="getting-help">
-<h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
+<h1>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h1>
 <p>If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue:</p>
 <ul class="simple">
 <li><p>Use our <a class="reference external" href="https://github.com/slackapi/python-slackclient/issues">Github Issue Tracker</a> for reporting bugs or requesting features.</p></li>
 <li><p>Visit the <a class="reference external" href="http://slackcommunity.com">Slack Developer Community</a> for getting help using slackclient (Legacy Python Slack SDK) or just generally bond with your fellow Slack developers.</p></li>
 </ul>
-</div>
 </div>
 
 

docs-v2/metadata.html

@@ -118,7 +118,7 @@
         <nav id="api_nav" class="col span_1_of_4">
           <div id="api_sections">
              <ul>
-<li class="toctree-l1"><a class="reference internal" href="index.html">slackclient (Legacy Python Slack SDK)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Important Notice</a></li>
 <li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens &amp; Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>
 <li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>