Merge pull request #67 from christianvogt/ct-labels

update connection types labels and annotations docs

documentation/components/dashboard/dashboardStorage.md

@@ -44,16 +44,18 @@ Features that impact all users or the Dashboard itself. These are only available
 * Serving Runtimes
     * These are stored as OpenShift Templates in the deployment namespace
       > Note: OpenShift Templates was an idea of future feature expansion and are not executed as OpenShift Templates today.
+* Connection Types
+    * These are stored as ConfigMaps in the deployment namespace
 
 ### Non-Admin Flows
 
 Flows that can be performed by any user, provided the [feature is enabled](./configuringDashboard.md#configuring-features-onoff).
 
 These are all stored as K8s resources using OCP or OpenShift AI backing CRDs.
 
-#### Data Connections
+#### Connections
 
-Data connections is a concept created by the Dashboard to store information relative to the user's Data Connection. This information is stored in a K8s secret of a specific structure:
+Connections is a concept created by the Dashboard to store information and enable users to connect to various data sources. This information is stored in a K8s secret. The data within these secrets conform to the schema defined within connection types. Connection types are predefined OOTB and can also be defined by an admin.
 
 ```yaml
 kind: Secret
@@ -76,4 +78,4 @@ data:
 type: Opaque
 ```
 
-See more information on the labels & annotations in the [Data Connection section of the K8s Labels & Annotations](./k8sLabelsAndAnnotations.md#data-connections)
+See more information on the labels & annotations in the [Connection section of the K8s Labels & Annotations](./k8sLabelsAndAnnotations.md#connections)

documentation/components/dashboard/k8sLabelsAndAnnotations.md

@@ -24,7 +24,8 @@ Dashboard has a reputation of using a lot of annotations and labels on various r
   * [`opendatahub.io/sc-config`]
 * [Specific Use-Cases](#specific-use-cases)
   * [DS Projects](#data-science-projects)
-  * [Data Connections](#data-connections)
+  * [Connection Types](#connection-types)
+  * [Connections](#connections)
   * [ImageStreams](#imagestreams)
   * [Notebooks](#notebooks)
   * [ServingRuntime Templates](#servingruntime-templates)
@@ -111,15 +112,24 @@ This annotation is used as internal Dashboard metadata to describe, enable, and
 For the Project Sharing feature specifically:
 * Label `opendatahub.io/project-sharing` is used to denote permissions crafted by Dashboard flows & thus show up in the Dashboard UI
 
-### Data Connections
+### Connection Types
 
-Specific additional items are used specifically in the usage of Data Connections.
+* Labels
+  * `opendatahub.io/connection-type` - a value of `true` indicates that the `ConfigMap` represents a connection type
+* Annotations
+  * [`openshift.io/display-name`]
+  * [`openshift.io/description`]
+  * `opendatahub.io/enabled` - a `true` or `false` value indicates whether the connection type is enabled for use
+  * `opendatahub.io/username` - the name of the user who created the connection type
+
+### Connections
 
 * Labels
-  * `opendatahub.io/managed` - helps us define that this is a managed resource by us and not a normal secret
+  * `opendatahub.io/managed` - helps us define that this is a managed resource by us and not a normal `Secret`
 * Annotations
   * [`openshift.io/display-name`]
-  * `opendatahub.io/connection-type` - the type of connection, currently this is only S3
+  * [`openshift.io/description`]
+  * `opendatahub.io/connection-type` - a reference to the connection type; eg. `s3`
 
 ### ImageStreams