New common 'VS Code Troubleshooting' page

docs/source/common/index.rst

@@ -13,4 +13,5 @@ Documentation on topics that are applicable across multiple NCSA computing resou
    quotas
    transfer
    relocate-conda-directory
+   vscode
 

docs/source/common/quotas.rst

@@ -3,6 +3,11 @@
 Quotas
 =======
 
+See :ref:`vscode-access-quota` if you are having issues logging in with VS Code.
+
+Quota Command
+---------------
+
 Execute the ``quota`` command to check the usage, soft quotas, and hard limits of your home directory and the shared directories you have access to.
 
 Block Used vs File Used

docs/source/common/vscode.rst

@@ -0,0 +1,42 @@
+.. _vscode-trouble:
+
+VS Code Troubleshooting 
+==============================
+
+.. _vscode-access-quota:
+
+Cannot Log in with VS Code - Disk Quota Exceeded
+-------------------------------------------------------
+
+When you log in to a system with VS Code, VS Code must be able to write to your home directory (``~/``) on log in. Therefore, if your home directory is at its quota/limit, you will not be able to log in to the system via VS Code. To resolve this:
+
+#. Use ``ssh`` to log in to the system in a **terminal**. Go to the system user guide for instructions on how to log in with ``ssh``:
+
+   - `Delta Login <https://docs.ncsa.illinois.edu/systems/delta/en/latest/user_guide/login.html>`_
+   - `DeltaAI Login <https://docs.ncsa.illinois.edu/systems/deltaai/en/latest/user-guide/login.html>`_
+   - `HAL Login <https://docs.ncsa.illinois.edu/systems/hal/en/latest/user-guide/login.html>`_
+   - `Hydro Login <https://docs.ncsa.illinois.edu/systems/hydro/en/latest/user-guide/accessing.html>`_
+   - `Illinois Campus Cluster Login <https://docs.ncsa.illinois.edu/systems/icc/en/latest/user_guide/accessing.html>`_
+   - `Illinois HTC Login <https://docs.ncsa.illinois.edu/systems/iccp-htc/en/latest/user-guide/accessing.html>`_
+   - `Nightingale Login <https://docs.ncsa.illinois.edu/systems/nightingale/en/latest/user_guide/accessing.html>`_
+
+#. Run the ``quota`` command on the system to see how much above the quota/limit you are in your **home directory**. Note, you may have reached your "Block Used" and/or "File Used" quota/limit. For a detailed explanation of the ``quota`` command output, see :ref:`quotas`.
+
+#. Delete files in your home directory (or move them to the ``/projects``, ``/scratch``, or ``/work`` directory, as appropriate) until you are below the quota/limit.
+
+#. After you have returned your home directory below the quota/limit, try to log in to the system using VS Code.
+
+We have also seen cases where it was necessary to remove ``$HOME/.vscode`` on the system, similar the `VS Code documentation - clean uninstall <https://code.visualstudio.com/docs/setup/uninstall#_clean-uninstall>`_.
+
+VS Code Performance Issues
+----------------------------
+
+Go to `Microsoft's VS Code Performance Issues Guide <https://github.com/Microsoft/vscode/wiki/Performance-Issues>`_ for steps to try to resolve different performance issues.
+
+You can run ``code --status`` in a VS Code terminal to display status information about your running VS Code and the workspace you have opened.
+
+..  image:: images/vscode/01_code_status.png
+    :alt: Using the code --status command with vscode.
+    :width: 700
+
+|

docs/source/index.rst

@@ -107,6 +107,7 @@ Addititional user documentation on topics common across two or more NCSA resourc
 - :ref:`transfer`
 - :ref:`quotas`
 - :ref:`conda`
+- :ref:`vscode-trouble`
 
 
 .. toctree::
@@ -133,6 +134,7 @@ Addititional user documentation on topics common across two or more NCSA resourc
    common/transfer
    common/quotas
    common/relocate-conda-directory
+   common/vscode
 
 .. toctree:: 
    :caption: Software Documentation