Skip to content

RHDHPAI-735: Configuration info and other issues to fix #1060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

pabel-rh
Copy link
Contributor

@pabel-rh pabel-rh commented Apr 8, 2025

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):
1.5.x, main, 1.6
Issue:
RHDHPAI-735
Preview:
https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1060/adoption-insights/

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Apr 8, 2025

@benwilcock
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Apr 8, 2025
@pabel-rh pabel-rh added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Apr 8, 2025
@evanshortiss
Copy link

Should this PR also mention the segment plugin issue from release notes? I think so

@pabel-rh
Copy link
Contributor Author

pabel-rh commented Apr 9, 2025

@evanshortiss, Regarding the part on including the disabling the segment plugin, it might be more appropriate to include it in the release notes, especially since it could be addressed in an upcoming release.
cc: @hmanwani-rh @Preeticp

Copy link

openshift-ci bot commented Apr 9, 2025

New changes are detected. LGTM label has been removed.

@evanshortiss
Copy link

evanshortiss commented Apr 9, 2025

@pabel-rh what if someone is excited to try the new feature, but doesn't read the release notes and encounters an error? IMO documentation should be complete for the reader in the now.

@pabel-rh pabel-rh added Technical review needed 🔩 Test all the procedures and removed Technical review done ⛅ Any procedure has been succesfully tested labels Apr 15, 2025
Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of comments / suggestions. Looks good overall!

@@ -24,9 +24,9 @@ image::rhdh-plugins-reference/active-users.jpg[active users]

This card displays the total number of users that have license to use {product}. It also provides a comparison of the number of *Logged-in users* and *Licensed users* in numeric and percentage form.

*Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in {product-short}
* *Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in {product-short}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* *Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in {product-short}
* *Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in to {product-short}


*Licensed users*: Total number of licensed users logged in {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.
* *Licensed users*: Total number of licensed users logged in {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* *Licensed users*: Total number of licensed users logged in {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.
* *Licensed users*: Total number of licensed users logged in to {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.

*Mostly in use by*: Type of user that used this template
*Executions*: Number of times this template was used
* *Name*: Name of the template
* *Mostly in use by*: Type of user that used this template
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type of user using this template most frequently?

Comment on lines +72 to +75
* *Name*: Name of the TechDoc
* *Entity*: Type of the TechDoc
* *Last used*: The last time the TechDoc was viewed
* *Views*: Number of times the TechDocs was visited
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Term check - Are we talking about TechDocs plugin views or documentation views in the TechDocs plugin? TechDoc is how we refer to the plugin. Documentation is the thing that is viewed inside the plugin. So if we mean documentation entries in the TechDocs plugin, let's say that instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants