documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Documentation needs clarifying around streaming-api server restarts

Open lambada opened this issue 3 years ago • 2 comments

Steps to reproduce the problem

  1. Read the Upgrading your Instance Documentation at https://docs.joinmastodon.org/admin/upgrading/

    Rarely, the streaming API server is also updated and requires a restart: systemctl restart mastodon-streaming The streaming API server is updated very rarely, and in most releases, does not require a restart. Restarting the streaming API leads to an increased load on your server as disconnected clients attempt to reconnect or poll the REST API instead, so avoid it whenever you can.

  2. Look at the Release Notes of the last couple of release lines... Excluding backports to older versions, The following contain 'Restart all Mastodon processes'
  • 4.0.2
  • 4.0.0
  • 3.5.3
  • 3.5.2
  • 3.5.1
  • 3.5.0 Whilst, excluding backports, the following releases do not say to 'restart all mastodon processes'
  • 4.0.1 does not, but it doesn't have any regular release notes covering the upgrade steps

Expected behaviour

The release notes should rarely say to update all processess

Actual behaviour

The release notes often say to update all processess

Detailed description

Are the release notes wrong in so often saying to restart 'all' mastodon processes, or should the docs be updated to reflect that restarting mastodon-streaming is perhaps more common than anticipated?

Specifications

Current live docs and release notes.

lambada avatar Nov 15 '22 22:11 lambada

@andypiper this should probably be moved to https://github.com/mastodon/documentation instead of the main project repo.

ThisIsMissEm avatar Sep 16 '23 18:09 ThisIsMissEm

@renchap could you move this to the documentation repo please? I don't have the ability to do that at present.

andypiper avatar Oct 23 '23 13:10 andypiper