Merge pull request #10612 from adityasharad/docs/system-requirements

Docs: Add CodeQL system requirements page

Author: adityasharad

docs/codeql/codeql-overview/index.rst

@@ -9,6 +9,8 @@ Learn more about how CodeQL works, the languages and libraries supported by Code
 
 - :doc:`Supported languages and frameworks <supported-languages-and-frameworks>`: View the languages, libraries, and frameworks supported in the latest version of CodeQL.
 
+- :doc:`System requirements <system-requirements>`: View the system requirements for running the latest version of CodeQL.
+
 - :doc:`CodeQL tools <codeql-tools>`: GitHub provides the CodeQL command-line interface and CodeQL for Visual Studio Code for performing CodeQL analysis on open source codebases.
 
 - :doc:`CodeQL glossary <codeql-glossary>`: An overview of the technical terms and concepts in CodeQL. 
@@ -19,6 +21,7 @@ Learn more about how CodeQL works, the languages and libraries supported by Code
 
    about-codeql
    supported-languages-and-frameworks
+   system-requirements
    codeql-tools
    codeql-glossary
 

docs/codeql/codeql-overview/system-requirements.rst

@@ -0,0 +1,35 @@
+:tocdepth: 1
+
+.. _system-requirements:
+
+System requirements
+-------------------
+
+System requirements for running the latest version of CodeQL.
+
+Supported platforms
+#######################
+
+.. include:: ../support/reusables/platforms.rst
+
+Additional software requirements
+################################
+
+To generate a CodeQL database for a compiled language, you must ensure that the system can successfully build and compile your code, independently of CodeQL.
+
+In addition, CodeQL extraction has the following requirements.
+
+For extraction of compiled languages (C/C++, C#, Go, Java) and Ruby on Linux:
+
+- ``glibc`` version 2.17 or greater must be installed.
+- ``musl-c``-based Linux distributions, such as Alpine Linux, are not supported.
+
+For TypeScript extraction on all platforms:
+
+- Node.js must be installed and available on the ``PATH`` as ``node``.
+
+For Python extraction:
+
+- On Linux and macOS, Python 3 must be installed and available on the ``PATH`` as ``python3`` or ``python``.
+- For Python 2 extraction on Linux and macOS, we also recommend having Python 2 installed and available on the ``PATH`` as ``python2``.
+- On Windows, the Python launcher must be installed and available on the ``PATH`` as ``py.exe``.

docs/codeql/index.html

@@ -97,6 +97,13 @@ <h3 class="Box-title text-mono f3 text-center">
                         <div class="Subhead-description">View the languages, libraries, and frameworks supported in the
                             latest version of CodeQL...</div>
                     </div>
+                    <div class="Subhead border-0">
+                        <a href="codeql-overview/system-requirements/">
+                            <div class="Subhead-heading f4 text-center">System requirements</div>
+                        </a>
+                        <div class="Subhead-description">View the system requirements for running the
+                            latest version of CodeQL...</div>
+                    </div>
                     <div class="Subhead border-0">
                         <a href="../publications">
                             <div class="Subhead-heading f4 text-center">Academic publications</div>

docs/codeql/support/reusables/platforms.rst

@@ -0,0 +1,29 @@
+.. csv-table::
+   :header-rows: 1
+   :widths: auto
+   :stub-columns: 1
+
+   Operating system,Supported versions,Supported CPU architectures
+   Linux,"Ubuntu 18.04
+
+   Ubuntu 20.04
+
+   Ubuntu 21.04
+
+   Ubuntu 22.04","x86-64"
+   Windows,"Windows 10 / Windows Server 2019
+
+   Windows 11 / Windows Server 2022","x86-64"
+   macOS,"macOS 10.15 Catalina
+
+   macOS 11 Big Sur
+
+   macOS 12 Monterey","x86-64
+
+   x86-64, arm64 (Apple Silicon)
+
+   x86-64, arm64 (Apple Silicon) [1]_"
+
+.. container:: footnote-group
+
+    .. [1] Support for Apple Silicon is currently in beta.