2i2c-org / features

Temporary location for feature requests sent to 2i2c
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Document how to make a maintenance announcement #24

Open consideRatio opened 1 year ago

consideRatio commented 1 year ago

If a maintenance timeframe has been planned with a community representative, it can be announced using configuration like below, which would be good to have documented somewhere.

@pnasrat proposed that it could be documentation we put maybe under SRE Guilde>Support Tasks or How-to to set maintenance announcements [...]

basehub:
  jupyterhub:
    hub:
      config:
        JupyterHub:
          # Announcement is a JupyterHub feature to present messages to users in
          # web pages under the /hub path (JupyterHub responds), but not via the
          # /user path (single-user server responds).
          #
          # ref: https://github.com/2i2c-org/infrastructure/issues/1501
          # ref: https://jupyterhub.readthedocs.io/en/stable/reference/templates.html#announcement-configuration-variables
          #
          template_vars:
            announcement: >-
              <strong>
              Service maintenance is scheduled Sunday March 19, to Monday 8AM
              EST.
              </strong>
              <br/>
              Running servers may be forcefully stopped and service disruption
              is expected.

Related