-
Task
-
Resolution: Unresolved
-
Normal
-
None
-
None
-
None
-
False
-
None
-
False
-
No
-
---
-
---
WHAT
We (i.e. MAS services) have not yet implemented the in-context help drawer provided by the PF quick start extension. This task is a spike to figure out how to do that using the designs provided for the Kafka instance reauth setting (MGDSTRM-8382).
WHY
To learn how to implement in-context help so that we can easily use this functionality when needed.
HOW
Some miscellaneous notes and resources from previous discussion:
- Here's more documentation for how to use the panel https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#in-app--in-context-help-panel
- In context help only ingests yaml at the moment. An example file is here: https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/in-context-help/example-topics.yaml
MGDSTRM-8814will be creating the product doc for the Kafka instance reauth setting. Therefore, the yaml file containing the in-context help text should be created in collaboration with the owner ofMGDSTRM-8814.
DONE
Include the following where applicable:
- The Kafka instance setting has an action that will toggle the in-context drawer open.
- Provide links to final implementation for future reference.
- Update contributing guide in relevant repos for easy reference.
- is blocked by
-
MGDSTRM-8382 [Design] I want to edit and view settings of my Kafka instance
- Closed
-
MGDSTRM-8814 [CCS] I want to edit and view settings for my Kafka instance
- Closed