routes: add description and logo url (#1766)

* routes: add description and logo url

* remove databroker settings

* add route to route logo url

* update id

Author: calebdoxsey

content/docs/reference/img/routes/route-description.png

@@ -21,7 +21,7 @@
     "id": "address",
     "title": "Address",
     "path": "/address",
-    "description": "Specifies the Host and Port to serve HTTP requests from.",
+    "description": "Specifies the IP Address and Port to serve HTTP requests from.",
     "short_description": "",
     "type": "string",
     "services": ["proxy"]
@@ -439,7 +439,7 @@
     "id": "http-redirect-address",
     "title": "HTTP Redirect Address",
     "path": "/http-redirect-address",
-    "description": "If set, HTTP Redirect Address specifies the Host and Port to redirect HTTP to HTTPS traffic on.",
+    "description": "If set, HTTP Redirect Address specifies the IP Address and Port to redirect HTTP to HTTPS traffic on.",
     "services": [],
     "type": "string"
   },
@@ -546,17 +546,24 @@
     "path": "/tracing",
     "services": []
   },
-  "tracing-provider": {
-    "id": "tracing-provider",
+  "tracing-otlp-endpoint": {
+    "id": "tracing-otlp-endpoint",
     "title": "Tracing Provider",
-    "description": "The name of the tracing provider. For example, Jaeger or Zipkin. Required.",
+    "description": "Endpoint URL for OTLP trace data. Required.",
+    "path": "/tracing",
+    "services": []
+  },
+  "tracing-otlp-protocol": {
+    "id": "tracing-otlp-endpoint",
+    "title": "Tracing Provider",
+    "description": "Transport protocol to be used for OTLP trace data.",
     "path": "/tracing",
     "services": []
   },
   "tracing-sample-rate": {
     "id": "tracing-sample-rate",
     "title": "Tracing Sample Rate",
-    "description": "The percentage of requests to sample in decimal notation. Default is 0.0001, or .01%. Optional.",
+    "description": "The percentage of requests to sample. Default is 100%.",
     "path": "/tracing",
     "services": []
   },
@@ -797,6 +804,14 @@
     "description": "Allows unauthenticated HTTP OPTIONS requests.",
     "type": "bool"
   },
+  "description": {
+    "id": "description",
+    "title": "Description",
+    "path": "/routes/description",
+    "services": ["proxy"],
+    "description": "Description of the route.",
+    "type": "string"
+  },
   "enable-google-cloud-serverless-authentication": {
     "id": "enable-google-cloud-serverless-authentication",
     "title": "Enable Google Cloud Serverless Authentication",
@@ -1057,9 +1072,9 @@
   },
   "logo-url": {
     "id": "logo-url",
-    "title": "Logo Url",
+    "title": "Logo URL",
     "path": "/branding#logo-url",
-    "description": "A Url pointing to your logo. Defaults to Pomerium's Logo.",
+    "description": "A URL pointing to your logo. Defaults to Pomerium's Logo.",
     "services": [],
     "type": "URL"
   },
@@ -1318,6 +1333,14 @@
     "description": "Modifies response headers before they are returned to the client. 'Header' matches the HTTP header name; 'prefix' will be replaced with 'value'.",
     "type": "object"
   },
+  "route-logo-url": {
+    "id": "route-logo-url",
+    "title": "Route Logo URL",
+    "path": "/routes/logo-url",
+    "services": ["proxy"],
+    "description": "The route logo URL.",
+    "type": "URL"
+  },
   "route-timeout": {
     "id": "route-timeout",
     "title": "Route Timeout",

content/docs/reference/reference.json

@@ -0,0 +1,45 @@
+---
+id: description
+title: Route Description
+keywords:
+  - reference
+  - Route Description
+pagination_prev: null
+pagination_next: null
+toc_max_heading_level: 2
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Route Description
+
+## Summary
+
+Route description shown in the routes portal.
+
+## How to configure
+
+<Tabs>
+<TabItem value="Core" label="Core">
+
+| **Config file key** | **Type** | **Usage**    |
+| :------------------ | :------- | :----------- |
+| `description`       | `string` | **optional** |
+
+</TabItem>
+<TabItem value="Enterprise" label="Enterprise">
+
+Set the route **description** under **General** route settings in the Console:
+
+![Set the route **description** under **General** route settings in the Console](../img/routes/route-description.png)
+
+</TabItem>
+<TabItem value="Kubernetes" label="Kubernetes">
+
+| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
+| :-- | :-- | :-- |
+| `description` | `string` | **optional** |
+
+</TabItem>
+</Tabs>

content/docs/reference/routes/description.mdx

@@ -0,0 +1,45 @@
+---
+id: logo-url
+title: Route Logo URL
+keywords:
+  - reference
+  - Route Logo URL
+pagination_prev: null
+pagination_next: null
+toc_max_heading_level: 2
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Route Logo URL
+
+## Summary
+
+Route logo URL shown in the routes portal.
+
+## How to configure
+
+<Tabs>
+<TabItem value="Core" label="Core">
+
+| **Config file key** | **Type** | **Usage**    |
+| :------------------ | :------- | :----------- |
+| `logo_url`          | `string` | **optional** |
+
+</TabItem>
+<TabItem value="Enterprise" label="Enterprise">
+
+Set the route **logo URL** under **General** route settings in the Console:
+
+![Set the route **logo URL** under **General** route settings in the Console](../img/routes/route-description.png)
+
+</TabItem>
+<TabItem value="Kubernetes" label="Kubernetes">
+
+| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
+| :-- | :-- | :-- |
+| `logo_url` | `string` | **optional** |
+
+</TabItem>
+</Tabs>