Skip to content

Commit

Permalink
Update/refactor beta documentation (#2806)
Browse files Browse the repository at this point in the history
* Update/refactor beta documentation

* fix links

* Update issue screenshot

* fix button name
  • Loading branch information
rzblue authored Oct 17, 2024
1 parent 309b785 commit 462cf02
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,16 @@
Accessing the Beta Project
==========================

The Beta Test project is located at: `<https://github.com/wpilibsuite/2025Beta>`__.

Signing In
----------

.. image:: images/accessing-the-beta-project/login.png
:alt: Logging in to the GitHub site.

Open your web browser and browse to `<https://github.com/wpilibsuite/2025Beta>`__. Near the top right corner of the page, click "Sign In" (if the Sign-In box does not automatically appear), enter your username and password and click "Sign In". If you have two-factor authenticatio enabled you may need to complete an action on your mobile device to verify your log in attempt.

The Project Homepage
--------------------
The 2025 Beta project is located at: `<https://github.com/wpilibsuite/2025Beta>`__.

.. image:: images/accessing-the-beta-project/project-home.png
:alt: The project homepage.

The project homepage contains a ReadMe file. Throughout the beta, the ReadMe section may be updated with the latest information from the *FIRST* technical staff. The top ribbon contains tabs allowing you to navigate to the different sections of the project:
The project homepage contains a README file. Throughout the beta, the README section may be updated with the latest information from the *FIRST* technical staff, WPILib, and vendors. The top ribbon contains tabs allowing you to navigate to the different sections of the project:

1. Code - The Code tab will take you to the ReadMe with Beta announcements as well as allow you to access file releases using the "Releases" section on the right hand side of the screen.
1. Code - The Code tab will take you to the README with Beta announcements as well as allow you to access file releases using the "Releases" section on the right hand side of the screen.
2. Issues - The Issues tab is where the bug tracker for the project is located.
3. Discussions - The Discussions tab contains a forum which will allow teams to post questions or discussions about the Beta test, software or documentation. Task reports will also be posted here.
4. Wiki - the Wiki tab will contain any documents to be distributed to Beta teams. We do not currently expect to use this but if there is any documentation that we want to restrict to Beta Teams only it will be posted here.
3. Discussions - The Discussions tab contains a forum which allows teams to post questions or discussions about the Beta test, software or documentation. Task reports should also be posted here.

To create your team's task report, make issue reports, or interact with discussions, you'll need to sign in to GitHub.
Near the top right corner of the page, click "Sign in", or "Sign up" if you don't already have an account, and follow the directions.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
4 changes: 2 additions & 2 deletions source/docs/beta/beta-getting-started/reporting-progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The Task Reports Section
------------------------

.. image:: images/reporting-progress/task-reports.png
:alt: The task reports section has a topic for each task.
:alt: The task reports section has a discussion topic for each task.

In the Task Reports section, click the "New Discussion" button to create a single discussion topic titled `Team XXXX Task Reports` for your team and post reports for all tasks into that thread. Each task will have suggested feedback listed in the :ref:`task documents <docs/beta/tasks/beta-task-overview:Beta Task Overview>`. Additional tasks can be posted to the same thread using the editing box at the bottom of the thread.
In the Task Reports section, click the :guilabel:`New Discussion` button to create a single discussion topic titled `Team XXXX Task Reports` for your team and post reports for all tasks into that thread. Each task will have suggested feedback listed in the :ref:`task documents <docs/beta/tasks/beta-task-overview:Beta Task Overview>`. Additional tasks can be posted to the same thread by adding comments using the text box at the bottom of the thread.

.. note:: We strongly prefer reports be done as text posts as opposed to attachments.
15 changes: 5 additions & 10 deletions source/docs/beta/beta-getting-started/trackers-reporting-bugs.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
.. include:: <isonum.txt>
Reporting Bugs or Other Issues
==============================

Issues - Reporting Bugs
=========================

.. warning:: While we will certainly accept and respond to all bugs posted in this project, we would prefer bugs for WPILib C++/Java components (libraries, VS Code, Shuffleboard, etc.) be submitted to the appropriate `wpilibsuite GitHub repositories <https://github.com/wpilibsuite>`__. Issues that belong in one of those projects will be moved from the Beta Project to the appropriate repository.

GitHub Issue Tracker
---------------------
If you encounter issues like bugs, incorrect/unclear documentation, or unexpected behavior, please open an issue on the [2025 Beta Test GitHub issue tracker](https://github.com/wpilibsuite/2025Beta/issues). Note that issues may be transferred to other repositories, but you will still be notified by GitHub of any updates.

.. image:: images/trackers-reporting-bugs/github-issues.png
:alt: The Github issues tab for the different projects in wpilibsuite.
:alt: The Github issues tab in the beta project.

To Report a bug, click the **Issues** tab and select **New issue**. A template should appear that will help prompt for useful items to report along with your issue. When done, click **Submit new issue**.
To report an issue, click the **Issues** tab and select :guilabel:`New issue`. Select :guilabel:`Bug report` and a template will appear that will help prompt for useful items to report along with your issue. When done, click :guilabel:`Create`.
4 changes: 2 additions & 2 deletions source/docs/beta/beta-getting-started/welcome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Before getting started with the :ref:`docs/beta/tasks/index:Beta Tasks` please r

- :ref:`docs/beta/beta-getting-started/accessing-the-beta-project:Accessing the Beta Project`
- :ref:`docs/beta/beta-getting-started/reporting-progress:Reporting Progress`
- :ref:`docs/beta/beta-getting-started/trackers-reporting-bugs:Issues - Reporting Bugs`
- :ref:`docs/beta/beta-getting-started/trackers-reporting-bugs:Reporting Bugs or Other Issues`
- :ref:`docs/beta/beta-getting-started/monitoring-via-email-notifications:Monitoring Via Email Notifications`
- :ref:`docs/beta/tasks/beta-task-overview:Beta Task Overview`

Please use the GitHub project as your primary means of communication. Members of the control system development team at CTRE, *FIRST*\ |reg|, NI, REV Robotics, and WPI are all monitoring the project and will strive to provide timely feedback and updates.
Please use the GitHub project as your primary means of communication. Members of the control system development team at CTRE, *FIRST*\ |reg|, NI, REV Robotics, and WPILib are all monitoring the project and will strive to provide timely feedback and updates.
8 changes: 4 additions & 4 deletions source/docs/beta/tasks/task-0-tools-and-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ The FRC Control System Beta Test will primarily be administered through a GitHub

- :ref:`docs/beta/beta-getting-started/accessing-the-beta-project:Accessing the Beta Project`
- :ref:`docs/beta/beta-getting-started/reporting-progress:Reporting Progress`
- :ref:`docs/beta/beta-getting-started/trackers-reporting-bugs:Issues - Reporting Bugs`
- :ref:`docs/beta/beta-getting-started/trackers-reporting-bugs:Reporting Bugs or Other Issues`
- :ref:`docs/beta/beta-getting-started/monitoring-via-email-notifications:Monitoring Via Email Notifications`

Beta Test Documentation
-----------------------

There will be 2 primary sources of Beta Test specific documentation. The first source is this manual which will primarily contain things like task instructions as well as documentation updated for the new season. This documentation is publicly accessible without a username or password.
There will be 2 primary sources of Beta Test specific documentation. The first source is this manual which will primarily contain things like task instructions as well as documentation updated for the new season.

The other source of documentation will be the Wiki section of the GitHub project. For more information on how to access that, see :ref:`docs/beta/beta-getting-started/accessing-the-beta-project:Accessing the Beta Project`. This document will any information intended to be limited to only beta teams. There may or may not be any documentation in this section.
The other source of documentation will be the Wiki section of the GitHub project. For more information on how to access that, see :ref:`docs/beta/beta-getting-started/accessing-the-beta-project:Accessing the Beta Project`. There may or may not be any documentation in this section.

Please read through the documentation in this section to understand the tasks associated with the Beta Test.

Run your robot with 2023 software and note the Free RAM on the DS diagnostics tab (for later comparison in task 3).
Run your robot with current (2024) software and note the Free RAM on the DS diagnostics tab (for later comparison in task 3).

Desired Feedback
----------------
Expand Down
2 changes: 1 addition & 1 deletion source/docs/beta/tasks/task-1-software-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Overview
--------
Documentation for installation can be found on the :ref:`docs/zero-to-robot/step-2/index:Step 2: Installing Software` page.

.. note:: For this task, use the files in the Releases sections of the Beta GitHub project instead of the files linked in the installation documentation.
.. note:: For this task, use the files in the README of the [Beta GitHub project](https://github.com/wpilibsuite/2025Beta) instead of the files linked in the installation documentation.

Desired Feedback
----------------
Expand Down
3 changes: 1 addition & 2 deletions source/docs/beta/tasks/task-3-port-code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,5 @@ Please keep the following questions in mind as you complete the task and include
2. What problems or difficulties did you encounter?
3. What questions did you have during the process?
4. Any specific suggestions on improving the documentation? (Were any instructions unclear?)
5. Compare the Free RAM on the DS diagnostics tab to similar code running on the 2023 image.
5. Compare the Free RAM on the DS diagnostics tab to similar code running on the 2024 image.
6. Is there anything else you want to tell us related to this task?

2 changes: 1 addition & 1 deletion source/docs/beta/tasks/task-4-new-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Task: Test any new features or heavily modified code
Overview
--------

The purpose of this task is to test any newly developed or heavily modified features for the new season. This will help the Control System team find any bugs or issues with the new code. A complete description of changes for 2023 can be found in the :doc:`/docs/yearly-overview/yearly-changelog` document. Below is a list of some of the new or modified features to focus on:
The purpose of this task is to test any newly developed or heavily modified features for the new season. This will help the Control System team find any bugs or issues with the new code. A complete description of changes for 2025 can be found in the :doc:`/docs/yearly-overview/yearly-changelog` document. Below is a list of some of the new or modified features to focus on:

**All languages**

Expand Down

0 comments on commit 462cf02

Please sign in to comment.