Skip to content

i18n(ko-KR): create sqld-server.mdx#102

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:sqld-server
Apr 20, 2025
Merged

i18n(ko-KR): create sqld-server.mdx#102
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:sqld-server

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 20, 2025

Description

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Korean-language guide for self-hosting a libSQL server with Docker and integrating it with StudioCMS, including setup instructions, authentication configuration, and example Docker Compose files.

@jsparkdev jsparkdev requested a review from a team as a code owner April 20, 2025 08:25
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 20, 2025

Walkthrough

A new Korean-language guide was introduced, providing step-by-step instructions for self-hosting a libSQL server using the sqld project from Turso, specifically for integration with StudioCMS. The document covers prerequisites, key generation, JWT token creation, Docker Compose setup options, environment configuration, and initial database setup procedures. It utilizes embedded UI components for clarity and includes a note for Coolify users regarding compatible configurations.

Changes

File(s) Change Summary
src/content/docs/ko/guides/database/sqld-server.mdx Added a comprehensive Korean guide for self-hosting a libSQL server with Docker and StudioCMS support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StudioCMS CLI
    participant OpenSSL
    participant Docker Compose
    participant libSQL Server

    User->>OpenSSL: Generate Ed25519 key pair
    User->>StudioCMS CLI: Create JWT token with private key
    User->>Docker Compose: Start libSQL server container (with keys/token)
    Docker Compose->>libSQL Server: Launch server with JWT authentication
    User->>StudioCMS CLI: Sync database schema/setup (remote)
    StudioCMS CLI->>libSQL Server: Connect and perform DB operations
Loading

Possibly related PRs

  • i18n(ko-KR): update getting-started.mdx #98: Updates the Korean getting-started document to include links referencing the new libSQL server self-hosting guide, directly linking the two documents.
  • i18n(ko-KR): update cli.mdx #96: Updates the Korean CLI documentation, including commands like crypto gen-jwt that are also used in the new guide, showing a direct relation through shared CLI command documentation.

Suggested labels

i18n

Suggested reviewers

  • Adammatthiesen

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
🪧 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.
    • Generate unit testing code for this file.
    • 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. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

  • 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.

@studiocms-no-reply
Copy link
Copy Markdown
Member

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
ko/guides/database/sqld-server.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (4)
src/content/docs/ko/guides/database/sqld-server.mdx (4)

7-10: Unify import statement formatting.
You currently have mixed semicolon usage (import ReadMore... no semicolon vs. the third import with semicolon). For consistency and to align with the project’s linting rules, please add or remove semicolons uniformly across all import lines.


21-34: Refine FileTree markup.
There is a blank line immediately after <FileTree> and the list items are unindented. To ensure the file tree renders as expected, remove the leading blank line and indent nested entries by two spaces under their parent directories.


36-47: Clean up code fence declarations.
The first Bash snippet fence has trailing spaces (```bash ) and some lines end with extra spaces. Please trim trailing whitespace from fences and use ```bash (without extra spaces) on its own line to avoid rendering issues.


116-119: Unify note presentation.
You’re using both <Aside type="note"> and the :::note MDX syntax elsewhere. For consistency, choose one pattern for informational notes across guides (preferably the <Aside> component) and align the style here.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd6be8a and c383c0d.

📒 Files selected for processing (1)
  • src/content/docs/ko/guides/database/sqld-server.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (8)
src/content/docs/ko/guides/database/sqld-server.mdx (8)

1-5: Verify front matter schema for localization.
The front matter defines i18nReady, title, and description, but many localized MDX files also include an explicit lang or locale field (e.g., lang: ko-KR). Please confirm that your front matter conforms to the i18n schema used by the site generator so this file is correctly picked up as Korean content.


11-14: Introduction is clear and well-translated.
The overview and the inline code formatting for sqld are accurate, and the ReadMore component is used correctly to link to upstream documentation.


15-20: Prerequisites section OK.
The list of dependencies is complete and the link references appear correct. No issues spotted here.


51-56: Validate <PackageManagers> usage.
You’re using <PackageManagers pkg='studiocms' type='run' .../>, but the PackageManagers component typically supports common tools like npm, yarn, or pnpm. Please confirm that passing pkg='studiocms' is supported, or consider switching to a plain code block if it isn’t.


59-64: .env snippet is correct.
The shell code block for updating the .env file is properly formatted and the instructions are clear.


120-146: Verify <Steps> component usage.
The <Steps> wrapper appears to contain plain markdown lists and nested components. Please confirm that the Steps component API accepts this format (some implementations require <Step> child components). If not, adjust to the documented pattern so the steps render correctly.


148-151: Conclusion paragraph is clear.
Great closing summary that reiterates the value of self-hosting sqld with StudioCMS.


152-156: Check link anchor validity.
The [getting-started] reference uses a long, Korean-fragment anchor (#최초-설정-또는-테이블-스키마가-업데이트된-경우-업데이트-중에). Please verify that this exactly matches the heading slug in the target document to avoid broken links.

Comment thread src/content/docs/ko/guides/database/sqld-server.mdx
Comment thread src/content/docs/ko/guides/database/sqld-server.mdx
@Adammatthiesen Adammatthiesen merged commit cc3c798 into withstudiocms:main Apr 20, 2025
8 checks passed
@jsparkdev jsparkdev deleted the sqld-server branch April 20, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants