-
Bug
-
Resolution: Done
-
Critical
-
1.9.0
-
2
-
False
-
-
False
-
Release Note Not Required
-
-
-
RHDH Documentation 3287
-
Critical
- Lightspeed docs keeps switching between 'Pinned chats section' and 'Favorites group' when refering to pinned chats. There is no mention of 'favorites' in lightspeed UI
2. In https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1649/navigate-rhdh-on-your-first-day/#proc-managing-chats_import-and-use-an-existing-template-for-faster-development the 8.3. Managing chats section tells users to to use the more options icon to open the side panel and manage chat history, and the display menu control to change the display method of the chat itself. Neither of those terms match the hover text from the UI. Hover the three dots (kebab) in the overlay, it says "Chatbot options" to get into the menu to adjust the display method, and the hamburger menu icon has the following hover text: "Chat history menu".
3. Clicking the mic button on Lightspeed looks like it tries to do something, but I wasn't able to get it to enter any text, using my laptop, or after plugging in headphones. Mic isn't mentioned in the doc section either: 8.3. Managing chats. If it's an official feature and expected to work, shouldn't it be mentioned? Mic button to enter text picked up by the mic [Need to confirm if this is a doc update or just a UI update]
4. Pinned vs Favorites in Lightspeed docs needs more work. In 8.4. Managing the visibility of the Favorites group, it mentions Favorites, which Lightspeed just calls Pinning. It also says that the pinning setting is in the chat history panel, but it's in the kebab "Chatbot options". From the chat history panel, you can access the pinned chat list, and use the horizontal kebab on a specific chat to pin it. "Always show Favorites group" is not present in the UI. Docs to be more detailed and use terminology present in the UI. Similar to Jan's issue above, but that one seemed focused on terminology, and I think the content also needs to be updated a bit for clarity.
5. Missing link from 9.3. Identifying integrations in the RHDH extensions marketplace
in the Lightspeed doc. In 9.3. Identifying integrations in the RHDH extensions marketplace, at the end there's Additional resources, which didn't resolve to a link. Is it a typo? placeholder? Introduction to plugins[Introduction to plugins]User is provided with a working link to the Introduction to plugins guide
6. Lightspeed install instructions list floating-action-button plugin as a prerequisite. In 1.4. Installing and configuring Red Hat Developer Lightspeed for Red Hat Developer Hub, it lists "You have installed and activated the floating-action-button plugins." as a prerequisite. My understanding is that we transitioned over to the global-header plugin to get similar functionality. In 1.9, we're announcing that global-floating-action-button is being deprecated, and will be removed in a few releases. The rolling demo environment doesn't have the floating-action-button plugin installed. https://issues.redhat.com/browse/RHDHPLAN-922Reference the correct plugin dependency. We're depending on globabl-header now.
7. Looks like there's a 1.8 hard coded reference to RHDH in the Lightspeed doc. Create Llama Stack Secret file (llama-stack-secrets): This file holds sensitive configuration data for your LLM provider and Llama Stack environment variables.
Important
Red Hat Developer Hub 1.8 configures the Llama Stack image to use the vLLM provider exclusively. The vLLM provider supports the OpenAI API schema but does not support connecting directly to the official OpenAI service (api.openai.com). Do not use the official OpenAI API URL or token with vLLM in this release. Attempting this might result in errors or improper responses. Native OpenAI provider support is planned for future releases. https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1649/developer-lightspeed/ . Other version references in this doc say 1.9, so this may have been missed. Should reflect the current product version.
8. Optional VLLM fields have no description. VLLM_MAX_TOKENS Optional.
VLLM_TLS_VERIFY Optional.
The formatting looks wrong at the end too, where SAFETY_API_KEY is jammed into the URL description
SAFETY_URL
The URL that hosts the safety model. This is post-fixed with /v1. For example: localhost:#/v1SAFETY_API_KEY: The API key for that model if applicable. The field purpose and usage to be described, as well as the fact that it isn't required. How will a user know if they need to put a value there, or what it should look like? Formatting to be correct, so it's clear how the values can be used.
9. Lightspeed Helm install instructions may be missing a configuration example. For a Helm-installed RHDH instance (Update the Helm chart):
Add your dynamic plugins configuration in the global.dynamic property.
Add your Developer Lightspeed for RHDH custom app config file to extraAppConfig:
All the other bullets here have some config inset, but there's nothing for that section. Maybe I'm not familiar enough with it, but by itself, it doesn't seem like enough to help me know how to set the globabl.dynamic property. Some more detail may be needed. Or maybe I need to learn more about helm.
10. Lightspeed 1.5.3 typos. 1.5.3. Customizing the chat history storage in Developer Lightspeed for RHDH
By default, the Developer Lightspeed for RHDH service stores chat history in a non-persistent local SQL database within in the LCS container. This means that chat history is lost if you create and use a new LCS sidecar. You can manually configure Developer Lightspeed for RHDH to store the chat history persistently as a long-term backup with PostgreSQL by updating your LCS service configuration. https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1649/developer-lightspeed/ . Doesn't need both "within in", and there's an extra + that can be deleted.
11. Inset Tip has no styling applied on 1.4. Installing and configuring Red Hat Developer Lightspeed for Red Hat Developer Hub. 1.4. Installing and configuring Red Hat Developer Lightspeed for Red Hat Developer Hub has an indented Tips section, which looks like it should have some visual style element added to it. Tip section to match other inset sections and have a visual element to set it off from the other content
12. The bulk-import fab config is misleading in lightspeed setup document. Directly using the example bulk-import FAB config is not working. Also the "icon: BulkImportIcon" should be " icon: bulkImportIcon". The bulk-import FAB config should indicate that the config is incomplete, there must be the rest of the whole bulk-import plugin frontend config for the plugin to display correctly.
The "icon: BulkImportIcon" should be " icon: bulkImportIcon"
13. Lightspeed layout and FAB button layout break when both bulk-import fab and lightspeed are enabled. Lightspeed layout and FAB button layout break when both bulk-import FAB and lightspeed are enabled - confirm if the note is added to the documentation.