How to suggest edits to https://developers.google.com/outline/docs/guides/service-providers/websockets?

[emohandesi]

The config.yaml file suggested in https://developers.google.com/outline/docs/guides/service-providers/websockets has formatting problems and causes an error when it is used to create a server as shown below:

azureuser@ws-outline:~$ cat config.yaml
web:
  servers:
    -   id: server1
      listen:
        -   "127.0.0.1:8080"

services:
  -   listeners:
      -   type: websocket-stream
        web_server: server1
        path: "/tcp"
      -   type: websocket-packet
        web_server: server1
        path: "/udp"
    keys:
      -   id: 1
        cipher: chacha20-ietf-poly1305
        secret: SHADOWSOCKS_SECRET

azureuser@ws-outline:~$ ./outline-ss-server -config=config.yaml
Jun 18 03:54:21.241 ERR Server failed to start. Aborting. err="failed to configure server: failed to load config (config.yaml): failed to parse config: yaml: line 2: did not find expected '-' indicator"

The following shows a corrected version of that config.yaml, which successfully runs the server.

web:
  servers:
    - id: server1
      listen:
        - "127.0.0.1:8080"

services:
  - listeners:
      - type: websocket-stream
        web_server: server1
        path: "/tcp"
      - type: websocket-packet
        web_server: server1
        path: "/udp"
    keys:
      - id: 1
        cipher: chacha20-ietf-poly1305
        secret: SHADOWSOCKS_SECRET

azureuser@ws-outline:~$ ./outline-ss-server -config=config.yaml
Jun 18 04:01:07.229 INF Web server started. ID=server1 address=127.0.0.1:8080
Jun 18 04:01:07.229 INF WebSocket stream service started. access_keys=1 fwmark=disabled ID=server1 path=/tcp
Jun 18 04:01:07.229 INF WebSocket packet service started. access_keys=1 fwmark=disabled ID=server1 path=/udp
Jun 18 04:01:07.229 INF Loaded config. access_keys=1 listeners=1

[ohnorobo]

Thanks for the heads up! These are in an internal system, so there's nowhere to suggest changes, but I'll get them fixed.