Merge branch '18995-code-cleanup-4'

[arvados.git] / services / ws / doc.go

diff --git a/services/ws/doc.go b/services/ws/doc.go
index d2805689210fef467ace420785c7bba31a3c6a75..a67df1511723fecf169f004a42abf1cabceec511 100644 (file)
--- a/services/ws/doc.go
+++ b/services/ws/doc.go
@@ -1,43 +1,16 @@
-// Arvados-ws is an Arvados event feed for Websocket clients.
+// Copyright (C) The Arvados Authors. All rights reserved.
 //
-// See https://doc.arvados.org/install/install-arvados-ws.html.
+// SPDX-License-Identifier: AGPL-3.0
+
+// Package ws exposes Arvados APIs (currently just one, the
+// cache-invalidation event feed at "ws://.../websocket") to
+// websocket clients.
 //
-// Usage
+// Installation and configuration
 //
-//     arvados-ws [-config /etc/arvados/ws/ws.yml] [-dump-config]
+// See https://doc.arvados.org/install/install-ws.html.
 //
-// Minimal configuration
+// Developer info
 //
-//     Client:
-//       APIHost: localhost:443
-//     Listen: ":1234"
-//     Postgres:
-//       dbname: arvados_production
-//       host: localhost
-//       password: xyzzy
-//       user: arvados
-//
-// Options
-//
-// -config path
-//
-// Load configuration from the given file instead of the default
-// /etc/arvados/ws/ws.yml
-//
-// -dump-config
-//
-// Print the loaded configuration to stdout and exit.
-//
-// Logs
-//
-// Logs are printed to stderr, formatted as JSON.
-//
-// A log is printed each time a client connects or disconnects.
-//
-// Runtime status
-//
-// GET /debug.json responds with debug stats.
-//
-// GET /status.json responds with health check results and
-// activity/usage metrics.
-package main
+// See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
+package ws