Add warning about creating projects on OneDrive (#2378)

wpilibsuite · Oct 30, 2023 · 61a6881 · 61a6881
1 parent 26afeeb
commit 61a6881
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/source/docs/software/vscode-overview/creating-robot-program.rst b/source/docs/software/vscode-overview/creating-robot-program.rst
@@ -133,6 +133,8 @@ Once all the above have been configured, click "Generate Project" and the robot
 
 .. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
 
+.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
+
 An example after all options are selected is shown below.
 
 .. image:: images/creating-robot-program/new-project-creator-configured.png

diff --git a/source/docs/software/vscode-overview/importing-gradle-project.rst b/source/docs/software/vscode-overview/importing-gradle-project.rst
@@ -33,6 +33,8 @@ You'll be presented with the WPILib Project Importer window. This is similar to
 6. **Enable Desktop Support**: If this is checked, simulation and unit test support is enabled. However, there are some cases where this will do some unexpected things. In addition, all vendor libraries need desktop support which not all libraries do.
 7. **Import Romi Project**: If this is checked, the project is imported using the Romi gradle template. This should only be checked for Romi projects.
 
+.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
+
 Click :guilabel:`Import Project` to begin the upgrade.
 
 The gradle project will be upgraded and copied into the new project directory. You can then either open the new project immediately using the pop-up below or open it later using the :kbd:`Ctrl+O` (or :kbd:`Command+O` for macOS) shortcut.

diff --git a/.../docs/zero-to-robot/step-4/creating-test-drivetrain-program-cpp-java-python.rst b/.../docs/zero-to-robot/step-4/creating-test-drivetrain-program-cpp-java-python.rst
@@ -33,6 +33,8 @@ Once all the above have been configured, click "Generate Project" and the robot
 
 .. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
 
+.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
+
 Opening The New Project
 -----------------------
-Original file line number
+Diff line change
@@ Expand Up @@
     .. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
+    .. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
     Opening The New Project
     -----------------------
@@ Expand Down @@