WIP jc-2197 test help-topic

docs/connectors/help-topics/poc-help-topic-1/metadata.yml

@@ -0,0 +1,2 @@
+kind: HelpTopic
+name: poc-help-topic-1

docs/connectors/help-topics/poc-help-topic-1/poc-help-topic-1.yml

@@ -0,0 +1,20 @@
+# Note that this topic is for LEARNING - POC TEST
+
+# Name is an internal name. Title shows up in the UI as a side panel title.
+# Tags to be kept empty for now. Tags specify where in the app, 
+# Links - only use external links. TBD whether referencing to other hep topic is supported but referencing customer portal docs is supported. Use this format for links: '[Link text](link url)'
+
+#This 
+- name: poc-help-topic-1
+  tags:
+  title: Create a namespace on an OpenShift cluster
+  content: |-
+    **POC help topic for Connectors context-sensitive help drawer**
+
+    You need a Connectors namespace for hosting your Connector instances. 
+    To create a Connectors namespace on your OpenShift Dedicated Customer Cloud Subscription (CCS) Trial cluster, follow the steps in "Adding the Red Hat OpenShift Connectors add-on to your OpenShift cluster". The trial has a 60-day lifespan and the number of Connectors instances that you create is not limited. The trial environment is useful when you want to create Proof of Concept solutions.
+  links:
+    - text: "Adding the Red Hat OpenShift Connectors add-on to your OpenShift cluster (external)"
+      href: "https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01"
+      isExternal: true
+

docs/connectors/help-topics/poc-help-topic-2/metadata.yml

@@ -0,0 +1,2 @@
+kind: HelpTopic
+name: poc-help-topic-2

docs/connectors/help-topics/poc-help-topic-2/poc-help-topic-2.yml

@@ -0,0 +1,20 @@
+# Note that this topic is for LEARNING - POC TEST
+# Name is an internal name. Title shows up in the UI as a side panel title.
+# Tags to be kept empty for now. Tags specify where in the app, 
+# Links - only use external links. TBD whether referencing to other hep topic is supported but referencing customer portal docs is supported. Use this format for links: '[Link text](link url)'
+- name: poc-help-topic-2
+  tags:
+    - page-1
+  title: Access Control List for Connectors
+  content: |-
+    **POC help topic for Connectors context-sensitive help drawer**
+
+    An Access Control List is a list of rules that specifies which users or systems are granted or denied access to a Connector. Each type of Connector requires specifc ACLs.You define ACLs in the Kafka instance. You can specify the same ACLs for all topics in the Kafka instance or for a specific topic.
+    You associate a Connector to a Kafka instance with a service account (client ID and secret). Use service accounts to connect and authenticate your Connector instances with topics in a Kafka instance.
+  links:
+    - text: "Managing account access in Red Hat OpenShift Streams for Apache Kafka (external)"
+      href: "https://access.redhat.com/documentation/en-us/red_hat_openshift_streams_for_apache_kafka/1/guide/2f4bf7cf-5de2-4254-8274-6bf71673f407#_8c08c9cc-437f-43d9-b3a2-499e67503f0b"
+      isExternal: true
+    - text: "Redhat Console (opens in new tab)"
+      href: "https://console.redhat.com"
+      newTab: true

docs/connectors/help-topics/template/example-topics.yaml

@@ -0,0 +1,154 @@
+# copied from https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/in-app-documentation/example-topics.yaml
+- name: auto-deploy
+  tags:
+    - page-1
+  title: Automatic Deployment
+  content: |-
+    **An Automatic Deployment** is...
+
+    Etiam viverra et tortor et maximus. Aliquam quis scelerisque metus. Proin luctus pretium sodales. Mauris nibh nibh, auctor eu scelerisque et, hendrerit a metus. Vivamus pharetra bibendum finibus. Sed a pulvinar ipsum. Fusce pharetra venenatis porttitor. Praesent justo metus, consectetur quis erat id, congue varius metus. Suspendisse dui est, tempor nec diam quis, facilisis sodales erat. Curabitur viverra convallis ex. Ut egestas condimentum augue, id euismod leo volutpat vitae. Quisque aliquet ac dolor quis pretium. Nunc at nibh quis arcu maximus elementum vel a mi.
+  links:
+    - text: "Creating quick starts (external)"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+      isExternal: true
+    - text: "Redhat Console (opens in new tab)"
+      href: "https://console.redhat.com"
+      newTab: true
+- name: workspace
+  tags:
+    - page-1
+    - page-2
+    - page-3
+  title: Workspace (no links)
+  content: |-
+    **A Workspace** is...
+
+    Fusce nunc risus, vehicula feugiat pellentesque sit amet, pretium non urna. Phasellus nibh mi, ornare quis euismod a, iaculis et eros. Vivamus auctor nunc odio, quis porttitor diam pellentesque nec. In et varius tellus, eget porta urna. Etiam bibendum, est eget mollis lobortis, velit risus efficitur lacus, sed pulvinar sem est vel libero. In sodales placerat tincidunt. Proin vitae risus elit. Ut lobortis ligula est, cursus rhoncus enim scelerisque ac. Donec lacus nisl, tempor porta hendrerit nec, volutpat vitae arcu. Curabitur ornare ullamcorper mi in tincidunt. Aenean efficitur posuere auctor. Pellentesque accumsan mauris vel arcu congue, nec sagittis nisl condimentum. Suspendisse mauris nulla, dignissim at viverra sed, fringilla eu purus.
+- name: alert-sample
+  tags:
+    - page-1
+  title: Alert Sample
+  content: |-
+    **A Sample of how to create alerts** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit.
+
+    [This is the note contents]{{admonition note}}
+    [This is the tip contents]{{admonition tip}}
+    [This is the important contents]{{admonition important}}
+    [This is the caution contents]{{admonition caution}}
+    [This is the warning contents]{{admonition warning}}
+
+- name: code-sample
+  tags:
+    - page-1
+  title: Code Sample
+  content: |-
+    **A Code Sample** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit.
+    ```
+    console.log("hello world")
+    ```
+    Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: manual-deployment
+  tags:
+    - page-2
+    - page-1
+  title: Manual Deployment
+  content: |-
+    **A Manual Deployment** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit.
+    ```
+    console.log("hello world")
+    ```
+    Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: target-port
+  tags:
+    - page-2
+  title: Target Port
+  content: |-
+    **A Target Port** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: build-configuration
+  tags:
+    - page-2
+  title: Build Configuration
+  content: |-
+    **A Build Configuration** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: run-time
+  tags:
+    - page-3
+  title: Runtime
+  content: |-
+    **A Runtime** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: deploy-configuration
+  tags:
+    - page-3
+  title: Deploy Configuration
+  content: |-
+    **A Deploy Configuration** is...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: environment-variables
+  tags:
+    - page-3
+  title: Environment Variables
+  content: |-
+    **Environment Variable** are...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"
+- name: health-checks
+  tags:
+    - page-3
+  title: Health Checks
+  content: |-
+    **Health Checks** are...
+
+    Vivamus pharetra vel risus id dignissim. Donec in nisl quis ligula rutrum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ullamcorper ex at lorem vehicula, id facilisis velit suscipit. Etiam elit ante, tempus sit amet maximus vel, laoreet vel quam. Sed sollicitudin ex sem, vel aliquam eros volutpat sit amet. Aliquam lobortis elementum sapien et dictum. Nullam interdum porttitor dapibus. Etiam id finibus libero, vitae vehicula metus. Mauris sit amet sollicitudin enim. Nullam tellus ante, ullamcorper sed odio vestibulum, dignissim luctus purus.
+  links:
+    - text: "Creating quick starts"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+    - text: "Redhat Console"
+      href: "https://console.redhat.com"

docs/connectors/help-topics/template/help-topic-template.yml

@@ -0,0 +1,21 @@
+# Note that this topic is a TEMPLATE
+# Name is an internal name. Title shows up in the UI as a side panel title.
+# Tags to be kept empty for now. Tags specify where in the app, 
+# Links - only use external links. TBD whether referencing to other hep topic is supported but referencing customer portal docs is supported. Use this format for links: '[Link text](link url)'
+
+- name: help-topic-name
+  tags:
+    - page-1
+  title: Title of Help Topic
+  content: |-
+    **Bold text heading**
+
+    Paragraph context
+
+  links:
+    - text: "Text (external)"
+      href: "https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html"
+      isExternal: true
+    - text: "Text (opens in new tab)"
+      href: "https://console.redhat.com"
+      newTab: true

docs/connectors/help-topics/template/metadata.yml

@@ -0,0 +1,2 @@
+kind: HelpTopic
+name: help-topic-template