Update documentation for dbscripts underscore directory names - #4154
Update documentation for dbscripts underscore directory names#4154indeewari wants to merge 1 commit into
Conversation
Follow-up to thunder-id#4149, which renamed the runtime dbscripts directories and their SQLite files to underscores (runtime_transient, runtime_persistent). Update the physical path references across the developer docs, deployment guides, the Helm and OpenChoreo READMEs, the db skill guide, and the architecture overview to match. Kubernetes Secret keys and prose references to the databases keep their existing kebab-case names. Refs thunder-id#4120
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (8)
📝 WalkthroughWalkthroughDocumentation references for runtime-transient and runtime-persistent databases changed from hyphenated to underscore-separated filenames, directories, and PostgreSQL script paths across architecture, configuration, deployment, and installation guides. ChangesDatabase Path Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install timed out. The project may have too many dependencies for the sandbox. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@ARCHITECTURE.md`:
- Line 12: Synchronize all documented database filenames, defaults, and script
paths with the implementation’s existing hyphenated names, or consistently
rename the implementation paths to the documented underscore-separated names.
Update ARCHITECTURE.md:12-12,
docs/content/community/contributing/contributing-code/debugging.mdx:161-162,
docs/content/guides/getting-started/configuration.mdx:204-204 and :314-314,
docs/content/guides/deployment-patterns/kubernetes.mdx:223-223 and :279-287,
docs/content/guides/deployment-patterns/openchoreo.mdx:205-207,
install/helm/README.md:426-426 and :467-467,
install/openchoreo/helm/README.md:225-227, and
install/openchoreo/thunderid-oc-resourcetype/README.md:56-58 so every reference
matches the corresponding backend defaults, Helm values, templates, SQLite
files, and PostgreSQL prerequisite scripts.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 17d82af2-c612-43b8-b1b2-01b0dea45712
⛔ Files ignored due to path filters (1)
.agent/skills/db/SKILL.mdis excluded by!.agent/skills/**
📒 Files selected for processing (8)
ARCHITECTURE.mddocs/content/community/contributing/contributing-code/debugging.mdxdocs/content/guides/deployment-patterns/kubernetes.mdxdocs/content/guides/deployment-patterns/openchoreo.mdxdocs/content/guides/getting-started/configuration.mdxinstall/helm/README.mdinstall/openchoreo/helm/README.mdinstall/openchoreo/thunderid-oc-resourcetype/README.md
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@coderabbitai full review |
✅ Action performedFull review finished. |
|
Superseded by #4164, which combines the code and documentation changes into a single PR targeting the |
2 participants
Purpose
Documentation follow-up to #4149, which renamed the two runtime
dbscripts/directories and their SQLite files from kebab-case to underscores
(
runtime_transient,runtime_persistent) so the directory name matches thedatabase name and config key.
This updates the physical path references that still pointed at the old
kebab-case names across:
.agent/skills/db/SKILL.md(cleanup artifact paths)ARCHITECTURE.md(SQLite file listing)docs/content/community/contributing/contributing-code/debugging.mdxdocs/content/guides/deployment-patterns/kubernetes.mdxdocs/content/guides/deployment-patterns/openchoreo.mdxdocs/content/guides/getting-started/configuration.mdxinstall/helm/README.mdinstall/openchoreo/helm/README.mdinstall/openchoreo/thunderid-oc-resourcetype/README.mdApproach
Changed only physical filesystem references (the
dbscripts/<dir>paths and the*.dbSQLite file paths). Left unchanged, as they belong to separate namingdomains and did not change in #4149:
runtime-transient-db-password,runtime-transient-redis-password).database", "Runtime-transient DB").
Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks
Summary by CodeRabbit
sqlitePath/connection examples across Kubernetes and OpenChoreo deployment instructions, as well as the contributing debugging reference and installation READMEs.