Update Connect documentation for 2.0 #3887
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Converting to draft since we're not ready to roll it out yet. But I'll get copy editing shortly! |
mudge
commented
Oct 17, 2024
mudge
force-pushed
the
connect-2.0
branch
2 times, most recently
from
1b41037
to
d1e8db4
Compare
Specifically: * Update the documentation for the new wfpanel plugin which replaces the built-in user interface * Update all screenshots with the latest Connect website * Prefer the new rpi-connect on, rpi-connect off, and rpi-connect restart commands instead of using systemctl directly * Remove instructions to manually restart after upgrade as this will now be done automatically * Promote the troubleshooting tips posted to the forums to the official documentation Note that the new user interface is a plugin for wfpanel which is separate from the "system tray" so switch to referring to the new icon as being "in the menu bar" to avoid any ambiguity.
mudge
commented
Oct 22, 2024
| @@ -1,7 +1,7 @@ | |||
| [[install-connect]] | |||
| == Install | |||
|
|
|||
| To begin installation, open a Terminal window. Run the following command to update your system and packages: | |||
| If Connect isn't already installed in your version of Raspberry Pi OS, open a Terminal window. Run the following command to update your system and packages: | |||
There was a problem hiding this comment.
@spl237 suggested:
Under Install, it might be worth mentioning that it can be installed from the Recommended Software GUI app, for those who don’t like terminal things. Only installs the full version, not lite.
As neither rpi-connect 1.4.0 nor rpi-connect-lite 1.4.0 clean up their systemd symlinks or stop their services on uninstall, it is important that users upgrade from rpi-connect 1.4.0 to rpi-connect 2.0.0 or they upgrade from rpi-connect-lite 1.4.0 to rpi-connect-lite 2.0.0. If they attempt to switch packages during the upgrade (i.e. go from rpi-connect 1.4.0 to rpi-connect-lite 2.0.0 or from rpi-connect-lite 1.4.0 to rpi-connect 2.0.0), the necessary migration script will not run leaving them in an inconsistent state until they either purge their old package or upgrade it. Document this issue by encouraging users to upgrade their existing package in place before any attempt to switch between rpi-connect and rpi-connect-lite.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Specifically:
Note that the new user interface is a plugin for wfpanel which is separate from the "system tray" so switch to referring to the new icon as being "in the menu bar" to avoid any ambiguity.