Add basic framework of new articles

This commit is contained in:
Felicity Chapman
2023-02-24 14:55:21 +00:00
parent 44dc5a1f0b
commit 874c362961
5 changed files with 79 additions and 2 deletions

View File

@@ -27,6 +27,11 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
VS Code to help you track the flow of data through a program, highlighting
areas that are potential security vulnerabilities.
- :doc:`Running CodeQL queries at scale with multi-repository variant analysis
<running-codeql-queries-at-scale-with-mrva>`: You can run queries against groups
of repositories on GitHub.com and view results in Visual Studio Code as each analysis
finishes.
- :doc:`Testing CodeQL queries in Visual Studio Code
<testing-codeql-queries-in-visual-studio-code>`: You can run unit tests for
CodeQL queries using the Visual Studio Code extension.
@@ -40,7 +45,13 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
- :doc:`Troubleshooting CodeQL for Visual Studio Code
<troubleshooting-codeql-for-visual-studio-code>`: You can use the detailed
information written to the extension's log files if you need to troubleshoot problems.
information written to the extension's log files if you need to troubleshoot problems with
analysis of local CodeQL databases.
- :doc:`Troubleshooting variant analysis
<troubleshooting-variant-analysis>`: You can use the detailed
information written to workflow log files in your controller repository if you need to
troubleshoot problems with analysis of CodeQL databases stored on GitHub.com.
- :doc:`About telemetry in CodeQL for Visual Studio Code <about-telemetry-in-codeql-for-visual-studio-code>`: If you specifically opt in to permit GitHub to do so, GitHub will collect usage data and metrics for the purposes of helping the core developers to improve the CodeQL extension for VS Code.
@@ -53,8 +64,10 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
analyzing-your-projects
exploring-the-structure-of-your-source-code
exploring-data-flow-with-path-queries
running-codeql-queries-at-scale-with-mrva
testing-codeql-queries-in-visual-studio-code
working-with-codeql-packs-in-visual-studio-code
customizing-settings
troubleshooting-codeql-for-visual-studio-code
troubleshooting-variant-analysis
about-telemetry-in-codeql-for-visual-studio-code

View File

@@ -0,0 +1,37 @@
:tocdepth: 1
.. _running-codeql-queries-at-scale-with-mrva:
Running CodeQL queries at scale with multi-repository variant analysis
======================================================================
.. include:: ../reusables/beta-note-mrva.rst
About multi-repository variant analysis
---------------------------------------
Explain what MVRA is, when it's useful, and basic billing (uses actions minutes for private repos).
.. _controller-repository:
About the controller repository
-------------------------------
Explain what a controller repository is, how to choose a good repository, can a team use a single repository, and any other questions that came up during the private beta test. Note that if you want to run MRVA on private repositories, you need to use a private controller repository to enable analysis.
Getting started with variant analysis
-------------------------------------
Explain how to set it up for the first time.
Explain how to run variant analysis.
Explain how the results view works.
Configuring variant analysis
----------------------------
Explain how to create your own list of repositories.
Explain how to change your controller repository.
Troubleshooting variant analysis
--------------------------------
For information on troubleshooting variant analysis, see
":ref:`Troubleshooting variant analysis <troubleshooting-variant-analysis>`."

View File

@@ -5,7 +5,12 @@
Troubleshooting CodeQL for Visual Studio Code
=============================================
You can use the detailed information written to the extension's log files if you need to troubleshoot problems.
This article explains how to debug problems with the analysis of CodeQL databases that are stored on your local
machine. For information on troubleshooting variant analysis, where the CodeQL dataabases are on GitHub.com, see
":ref:`Troubleshooting variant analysis <troubleshooting-variant-analysis>`."
You can use the detailed information written to the extension's log files if you need to troubleshoot problems
analysing CodeQL databases that are stored locally.
About the log files
--------------------

View File

@@ -0,0 +1,15 @@
:tocdepth: 1
.. _troubleshooting-variant-analysis:
Troubleshooting variant analysis
================================
.. include:: ../reusables/beta-note-mrva.rst
This article explains how to debug problems with variant analysis. That is, analysis where the
CodeQL databases are on GitHub.com and not locally on your machine.
For information on troubleshooting local analysis, see
":ref:`Troubleshooting CodeQL for Visual Studio Code <troubleshooting-codeql-for-visual-studio-code>`."

View File

@@ -0,0 +1,7 @@
.. pull-quote::
Note
Multi-repository variant analysis is currently available as a beta release and is subject to change. To use this feature you must upgrade the CodeQL extension for Visual Studio Code to a minimum of version 1.8.0.
To provide feedback on the feature, see TODO-community-feedback-link.