docs: add cobol notes

james · james · commit fe3a90831771 · 2019-12-04T16:36:44.000Z
diff --git a/docs/language/global-sphinx-files/global-conf.py b/docs/language/global-sphinx-files/global-conf.py
@@ -56,9 +56,9 @@ def setup(sphinx):
 # built documents.
 #
 # The short X.Y version.
-version = u'1.22.1'
+version = u'1.23'
 # The full version, including alpha/beta/rc tags.
-release = u'1.22.1'
+release = u'1.23'
 copyright = u'2019 Semmle Ltd'
 author = u'Semmle Ltd'
 
diff --git a/docs/language/learn-ql/cobol/ql-for-cobol.rst b/docs/language/learn-ql/cobol/ql-for-cobol.rst
@@ -6,15 +6,15 @@ CodeQL for COBOL
    :hidden:
 
    introduce-libraries-cobol
-   
+
+.. include:: ../../support/cobol-note.rst
+
 This page provides an overview of the CodeQL for COBOL documentation that is currently available.
 
--  `Basic COBOL query <https://lgtm.com/help/lgtm/console/ql-cobol-basic-example>`__ describes how to write and run queries using LGTM.
 -  :doc:`Introducing the CodeQL libraries for COBOL <introduce-libraries-cobol>` introduces the standard libraries used to write queries for COBOL code.
 
 
 Other resources
 ---------------
 
--  For the queries used in LGTM, display a `COBOL query <https://lgtm.com/search?q=language%3Acobol&t=rules>`__ and click **Open in query console** to see the code used to find alerts.
 -  For more information about the library for COBOL see the `CodeQL library for COBOL <https://help.semmle.com/qldoc/cobol/>`__.
diff --git a/docs/language/support/cobol-note.rst b/docs/language/support/cobol-note.rst
@@ -0,0 +1,5 @@
+.. pull-quote:: Important
+
+   CodeQL for COBOL is being deprecated after the 1.23 release of CodeQL. 
+   Future releases, starting with 1.24, will no longer contain support for analyzing COBOL source code. 
+   We are not aware of any customers who will be affected by this change. If you do have any concerns, please contact your account manager.
diff --git a/docs/language/support/conf.py b/docs/language/support/conf.py
@@ -80,4 +80,4 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['read-me-project.rst']
+exclude_patterns = ['read-me-project.rst', 'cobol-note.rst']
diff --git a/docs/language/support/framework-support.rst b/docs/language/support/framework-support.rst
@@ -24,6 +24,8 @@ C# built-in support
 COBOL built-in support
 ===================================
 
+.. include:: cobol-note.rst
+
 * Embedded SQL
 * Embedded CICS
 
diff --git a/docs/language/support/language-support.rst b/docs/language/support/language-support.rst
@@ -10,6 +10,8 @@ Customers with any questions should contact their usual Semmle contact with any
 If you're not a customer yet, contact us at info@semmle.com 
 with any questions you have about language and compiler support.
 
+.. include:: cobol-note.rst
+
 .. csv-table::
      :file: versions-compilers.csv
      :header-rows: 1
