Skip to content

docs(package): Fix incorrect logs_input.storage.directory reference in Docker Compose multi-host guide.#2076

Open
junhaoliao wants to merge 3 commits intoy-scope:mainfrom
junhaoliao:docs-input-dir
Open

docs(package): Fix incorrect logs_input.storage.directory reference in Docker Compose multi-host guide.#2076
junhaoliao wants to merge 3 commits intoy-scope:mainfrom
junhaoliao:docs-input-dir

Conversation

@junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented Mar 5, 2026

Description

The multi-host Docker Compose deployment guide incorrectly refers to logs_input.storage.directory
when instructing users to configure filesystem storage paths. The logs_input config key does not
have a storage sub-key - its directory field sits directly under logs_input.

The correct config structure (from
clp-config.template.json.yaml):

logs_input:
  type: "fs"
  directory: "/"          # directly under logs_input (no "storage" sub-key)

This PR corrects logs_input.storage.directorylogs_input.directory in the relevant line of
the Docker Compose deployment guide.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

1. Docs build succeeds

Task: Verify the docs site builds without errors after the one-line change.

Command:

$ task docs:clean && task docs:site

Output:

task: [docs:clean] rm -rf '/home/junhao/workspace/6-clp/build/docs/html'
...
build succeeded.

The HTML pages are in ../build/docs/html.

2. Rendered page contains the corrected key

Task: Confirm the rendered HTML page shows logs_input.directory and no longer shows
logs_input.storage.directory.

Command:

$ task docs:serve &
$ curl -s http://127.0.0.1:8081/user-docs/guides-docker-compose-deployment.html \
    | grep -o 'logs_input[^<]*directory'

Output:

logs_input.directory

Explanation: The page now correctly references logs_input.directory.

Summary by CodeRabbit

  • Documentation
    • Updated Docker Compose deployment guide to reflect changes in configuration naming for local filesystem storage setup.

@junhaoliao junhaoliao requested a review from a team as a code owner March 5, 2026 21:42
@junhaoliao junhaoliao requested a review from kirkrodrigues March 5, 2026 21:42
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c176135a-bf75-48e6-87fc-7cef87f903c3

📥 Commits

Reviewing files that changed from the base of the PR and between dbc1799 and 2d7b0e7.

📒 Files selected for processing (1)
  • docs/src/user-docs/guides-docker-compose-deployment.md

Walkthrough

Documentation updated to reflect a configuration key rename from logs_input.storage.directory to logs_input.directory for local filesystem storage in Docker Compose deployment instructions.

Changes

Cohort / File(s) Summary
Documentation Update
docs/src/user-docs/guides-docker-compose-deployment.md
Configuration key renamed from logs_input.storage.directory to logs_input.directory in deployment guide documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing an incorrect configuration key reference in Docker Compose documentation from logs_input.storage.directory to logs_input.directory.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • 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

Comment @coderabbitai help to get the list of available commands and usage tips.

@junhaoliao junhaoliao added this to the March 2026 milestone Mar 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant