LCORE-472: Add data collection documentation

[onmete]

Description

Add data collection documentation

Relevant PR in exporter side lightspeed-core/lightspeed-to-dataverse-exporter#26

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Related Tickets & Documents

• Related Issue #
• Closes #

Checklist before requesting a review

• I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Testing

• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

Summary by CodeRabbit

• Documentation
  • Added a “User data collection” section with a YAML configuration example (feedback/transcript options and storage backends) and notes on extensibility.
  • Introduced a “Data Export Integration” section describing integration with Red Hat’s Dataverse exporter, a quick integration workflow, and a link to the exporter repo.
  • Updated the Table of Contents to include the new sections.
  • Note: the new sections appear in two places; no code or public API changes.

[coderabbitai]

Walkthrough

Adds documentation to README.md describing user data collection configuration (YAML example) and a Data Export Integration with the lightspeed-to-dataverse-exporter, including quick integration steps and a repo link. Changes are documentation-only; no code or public API changes.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added “User data collection” section with YAML config (feedback_enabled, feedback_storage, transcripts_enabled, transcripts_storage). Added “Data Export Integration” section (quick integration steps, deploy exporter, repository link). Updated Table of Contents. Note: sections duplicated within the README.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my nose at README light,
New knobs for data, snug and right.
Export burrows to Dataverse gleam,
YAML crumbs map out the stream.
Thump—docs hop on, carrot dream. 🥕✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7cbdfc7 and fd94d20.

📒 Files selected for processing (1)

• README.md (4 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

221-221: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

222-222: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

223-223: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

224-224: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

🔇 Additional comments (1)

README.md (1)

56-57: LGTM: ToC entry added for Data Export Integration

The new ToC entry points to the section anchor and keeps navigation consistent.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (4)

README.md (4)

12-13: Clarify Dataverse branding/scope to avoid implying vendor lock-in

Recommend neutral phrasing since the exporter should work with any Dataverse instance.

-The service includes comprehensive user data collection capabilities for various types of user interaction data, which can be exported to Red Hat's Dataverse for analysis using the companion [lightspeed-to-dataverse-exporter](https://github.com/lightspeed-core/lightspeed-to-dataverse-exporter) service.
+The service includes comprehensive user data collection capabilities for various types of user interaction data, which can be exported to Dataverse (including Red Hat's internal instance) for analysis using the companion [lightspeed-to-dataverse-exporter](https://github.com/lightspeed-core/lightspeed-to-dataverse-exporter) service.

---

27-27: Fix markdownlint MD007: unordered list indentation (ToC)

mdlint expects 2 spaces for nested bullets; this entry uses 4. Either regenerate the ToC (preferred) or adjust indentation consistently.

-    * [User data collection](#user-data-collection)
+  * [User data collection](#user-data-collection)

Note: Other ToC nested bullets also use 4 spaces; consider regenerating the full ToC via vim-markdown-toc to make all entries consistent.

---

213-216: Fix markdownlint MD004: unordered list style

The linter expects asterisks for list items; these lines use dashes.

-- `feedback_enabled`: Enable/disable collection of user feedback data
-- `feedback_storage`: Directory path where feedback JSON files are stored
-- `transcripts_enabled`: Enable/disable collection of conversation transcripts
-- `transcripts_storage`: Directory path where transcript JSON files are stored
+* `feedback_enabled`: Enable/disable collection of user feedback data
+* `feedback_storage`: Directory path where feedback JSON files are stored
+* `transcripts_enabled`: Enable/disable collection of conversation transcripts
+* `transcripts_storage`: Directory path where transcript JSON files are stored

---

456-466: Ensure path consistency across docs

This snippet uses /shared/data/... while the earlier config examples under “Llama Stack as separate server/client” use /tmp/data/.... Readers may assume those are interchangeable. Consider aligning these paths or adding a short note explaining that any path works as long as both services use the same mount.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c09653b and 7cbdfc7.

📒 Files selected for processing (1)

• README.md (5 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

27-27: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

213-213: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

214-214: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

215-215: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

216-216: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: e2e_tests

[umago]

Seems quite reasonable by pointing just hinting about the dataverse exporter while linking/guiding users to the exporter documentation for a full configuration/setup. LGTM

[tisnik]

LGTM