Skip to content

Conversation

@josh-wong
Copy link
Member

Description

This PR adds new and updated ScalarDB Analytics docs for ScalarDB 3.16. This is a tentative addition/update as we finalize the docs.

Related issues and/or PRs

N/A

Changes made

  • Added the following docs (in English and Japanese) as a tentative publication:
    • scalardb-analytics/administration.mdx
    • scalardb-analytics/configuration.mdx
  • Added the following updated docs (in English and Japanese) as a tentative publication:
    • scalardb-analytics/run-analytical-queries.mdx
    • scalardb-analytics/design.mdx
  • Added the new docs to the sidebar navigation of 3.16.
  • Added a redirect.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong josh-wong self-assigned this Aug 6, 2025
@josh-wong josh-wong added the documentation Improvements or additions to documentation label Aug 6, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @josh-wong, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've added new and updated documentation for ScalarDB Analytics, specifically for ScalarDB 3.16. This includes new guides for administration and configuration, along with revisions to existing design and query execution documents. These changes are being published tentatively as we finalize the content.

Highlights

  • New Documentation: I've introduced comprehensive guides for ScalarDB Analytics administration and configuration, providing detailed instructions for setting up and managing the server and its components.
  • Updated Documentation: I've revised existing documents for ScalarDB Analytics design and how to run analytical queries, streamlining information and improving clarity for users.
  • Sidebar Navigation Updates: The new documentation has been integrated into the 3.16 sidebar navigation, making it easier for users to discover and access relevant information.
  • Content Refactoring: To improve content organization, I've refactored detailed catalog and data type mapping information from the design.mdx file to the new administration.mdx.
  • Spark Integration Simplification: I've updated the run-analytical-queries.mdx to reflect that data source configurations are now managed by the catalog server, simplifying the Spark setup process for users.
  • Localization Support: Japanese translations have been added for all new and updated ScalarDB Analytics documentation, ensuring broader accessibility for our users.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces significant updates to the ScalarDB Analytics documentation, including new pages for administration and configuration, and refactoring existing pages for clarity and to reflect architectural changes. The changes are well-structured and greatly improve the documentation by centralizing reference material and simplifying the content in design and usage guides. I've identified a few minor syntax issues in the new markdown files, such as incorrect admonition syntax and redundant default properties in tab components. Addressing these will ensure the documentation renders correctly and behaves as expected.

@josh-wong josh-wong force-pushed the add-scalardb-analytics-docs-tentatively branch from 20422cc to 6e12a8f Compare August 6, 2025 10:01
@josh-wong josh-wong merged commit 2b60728 into main Aug 6, 2025
1 check passed
@josh-wong josh-wong deleted the add-scalardb-analytics-docs-tentatively branch August 6, 2025 10:23
@josh-wong josh-wong changed the title Add new and updated ScalarDB Analytics docs (tentatively) Add new and updated ScalarDB Analytics docs (tentative update) Aug 18, 2025
@josh-wong josh-wong mentioned this pull request Aug 18, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant