Skip to content
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

Update Connect documentation for 2.0 #3887

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Update Connect documentation for 2.0 #3887

wants to merge 2 commits into from

Commits on Oct 21, 2024

  1. Update Connect documentation for 2.0

    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 committed Oct 21, 2024
    Configuration menu
    Copy the full SHA
    b218dbe View commit details
    Browse the repository at this point in the history

Commits on Oct 22, 2024

  1. Document issue upgrading between Connect packages

    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.
    mudge committed Oct 22, 2024
    Configuration menu
    Copy the full SHA
    607cf01 View commit details
    Browse the repository at this point in the history