Skip to content

[draft] Remove content for removed features in 2027 #3040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: 2027
Choose a base branch
from

Conversation

Gold856
Copy link
Contributor

@Gold856 Gold856 commented May 27, 2025

References to old Java tools and other features removed in 2027 WPILib have been removed. Some Labview pages were taken out of indices.

@Gold856 Gold856 force-pushed the 2027 branch 2 times, most recently from 9decb52 to bcb1a3b Compare May 27, 2025 20:45
@Gold856 Gold856 changed the title [draft] 2027 docs [draft] Remove files for removed features in 2027 May 27, 2025
@Gold856 Gold856 changed the title [draft] Remove files for removed features in 2027 [draft] Remove content for removed features in 2027 May 27, 2025
@sciencewhiz
Copy link
Collaborator

I won't have a chance to review in detail for a while. However, from a usability perspective (and SEO) I think I'd tend to prefer replacing things with stubs that point to replacement rather then a wholesale delete for 2027. Since it's a massive PR, and I've only been able to glance at it, I can't tell if that's what you've done.

See also #3041. I think it might be easier to reorganize first then delete if we're keeping stubs.

@Gold856
Copy link
Contributor Author

Gold856 commented May 28, 2025

It's just wholesale deletes with some minor spot fixes to remove references or use alternate ones, e.g. replacing Shuffleboard with Elastic. And yeah, I think a reorganization first might be easier. Although I'm not exactly sure if stubs would be particularly useful compared to just using rediraffe. I suppose if we use one stub for every major removed component like SmartDashboard and Shuffleboard, that'd be fine.

What I might do is move the spot fixes (the first commit) into a separate PR, which would allow us to be more aggressive in moving/deleting stuff. If you're going to review any part of this, review the first commit only. The rest is just wholesale deletes.

@sciencewhiz
Copy link
Collaborator

Although I'm not exactly sure if stubs would be particularly useful compared to just using rediraffe. I suppose if we use one stub for every major removed component like SmartDashboard and Shuffleboard, that'd be fine.

Right, that was what I was envisioning. Redirect any SmartDashboard article to the stub, and the stub can explain why it's no longer supported and link to alternates. I think that's a better user experience then redirecting any smartdashboard article to some other dashboard article without any explanation.

@@ -25,8 +25,6 @@ The :guilabel:`Command Selector` widget allows you to start and cancel a specif
SmartDashboard.putData("My Command", command)
```

.. note:: The ``MyCommand`` instance can also be sent using a lower-level NetworkTables API or using the :ref:`Shuffleboard API <docs/software/dashboards/shuffleboard/getting-started/shuffleboard-displaying-data:Displaying data from your robot>`. In this case, the ``SmartDashboard`` API was used, meaning that the :guilabel:`Command Selector` widget will appear under the ``SmartDashboard`` table name.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sending with the lower-level NT API still seems relevant, but eventually this article needs to be updated for the new telemetry API.

@@ -34,8 +34,6 @@ To send your robot's position (usually obtained by :ref:`odometry <docs/software
self.field.setRobotPose(self.odometry.getPose())
```

.. note:: The ``Field2d`` instance can also be sent using a lower-level NetworkTables API or using the :ref:`Shuffleboard API <docs/software/dashboards/shuffleboard/getting-started/shuffleboard-displaying-data:Displaying data from your robot>`. In this case, the ``SmartDashboard`` API was used, meaning that the :guilabel:`Field2d` widget will appear under the ``SmartDashboard`` table name.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@Gold856 Gold856 force-pushed the 2027 branch 3 times, most recently from 50ea6b2 to 39363bf Compare June 20, 2025 03:26
@Gold856 Gold856 force-pushed the 2027 branch 2 times, most recently from 135a845 to cd132a4 Compare June 20, 2025 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants