Skip to content

Commit

Permalink
make gradle import docs more visible (#2568)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
  • Loading branch information
TheTripleV and sciencewhiz committed Feb 5, 2024
1 parent ae00a2a commit 1eae253
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Importing a Gradle Project
==========================
Importing Last Year's Robot Code
================================

Due to changes in the project, it is necessary to update the build files for a previous years Gradle project. It is also necessary to import vendor libraries again, since last year's vendor libraries must be updated to be compatible with this year's projects.

Expand Down
2 changes: 1 addition & 1 deletion source/docs/software/vscode-overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ VS Code Overview
deploying-robot-code
viewing-console-output
debugging-robot-program
importing-gradle-project
importing-last-years-robot-code
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To access these commands, press Ctrl+Shift+P to open the Command Palette, then b
- **WPILib: Debug Robot Code** - Build and deploy robot code to roboRIO in debug mode and start debugging
- **WPILib: Deploy Robot Code** - Build and deploy robot code to roboRIO
- **WPILib: Hardware Sim Robot Code** - This builds the current robot code project on your PC and starts it running in simulation using hardware attached to the comupter rather then pure software simulation. Requires vendor support.
- **WPILib: Import a WPILib 2020-2023 Gradle Project** - Open a wizard to help you create a new project from a existing VS Code Gradle project from 2020-2022. Further documentation is at :doc:`importing gradle project </docs/software/vscode-overview/importing-gradle-project>`
- **WPILib: Import a WPILib 2020-2023 Gradle Project** - Open a wizard to help you create a new project from a existing VS Code Gradle project from 2020-2022. Further documentation is at :doc:`importing gradle project </docs/software/vscode-overview/importing-last-years-robot-code>`
- **WPILib: Install tools from GradleRIO** - Install the WPILib Java tools (e.g. SmartDashboard, Shuffleboard, etc.). Note that this is done by default by the offline installer
- **WPILib: Manage Vendor Libraries** - Install/update 3rd party libraries
- **WPILib: Open API Documentation** - Opens either the WPILib Javadocs or C++ Doxygen documentation
Expand Down
2 changes: 1 addition & 1 deletion source/docs/yearly-overview/returning-quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ It is advised that **all** teams read through the :doc:`changelog </docs/yearly-
3. :doc:`Install WPILib </docs/zero-to-robot/step-2/wpilib-setup>` (Java / C++ teams only)
4. :doc:`Update third party libraries </docs/software/vscode-overview/3rd-party-libraries>`
5. Reimage :doc:`roboRIO 1 </docs/zero-to-robot/step-3/imaging-your-roborio>` or :doc:`roboRIO 2 </docs/zero-to-robot/step-3/roborio2-imaging>`
6. :doc:`Import robot project </docs/software/vscode-overview/importing-gradle-project>` (Java / C++ teams only)
6. :doc:`Import robot project </docs/software/vscode-overview/importing-last-years-robot-code>` (Java / C++ teams only)
7. Update software based on the changes described in the :doc:`changelog </docs/yearly-overview/yearly-changelog>`
2 changes: 1 addition & 1 deletion source/docs/yearly-overview/yearly-changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It's recommended to also review the list of :doc:`known issues <known-issues>`.
Importing Projects from Previous Years
--------------------------------------

Due to internal GradleRIO changes, it is necessary to update projects from previous years. After :doc:`Installing WPILib for 2024 </docs/zero-to-robot/step-2/wpilib-setup>`, any 2023 projects must be :doc:`imported </docs/software/vscode-overview/importing-gradle-project>` to be compatible.
Due to internal GradleRIO changes, it is necessary to update projects from previous years. After :doc:`Installing WPILib for 2024 </docs/zero-to-robot/step-2/wpilib-setup>`, any 2023 projects must be :doc:`imported </docs/software/vscode-overview/importing-last-years-robot-code>` to be compatible.

Major Changes (Java/C++)
------------------------
Expand Down
1 change: 1 addition & 0 deletions source/redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -292,3 +292,4 @@
"docs/software/pathplanning/system-identification/configuring-project.rst" "docs/software/advanced-controls/system-identification/creating-routine.rst"
"docs/software/pathplanning/system-identification/identification-routine.rst" "docs/software/advanced-controls/system-identification/running-routine.rst"
"docs/software/advanced-controls/geometry/coordinate-systems.rst" "docs/software/basic-programming/coordinate-system.rst"
"docs/software/vscode-overview/importing-gradle-project.rst" "docs/software/vscode-overview/importing-last-years-robot-code.rst"

0 comments on commit 1eae253

Please sign in to comment.