-
Notifications
You must be signed in to change notification settings - Fork 0
Add ScalarDL 3.12 docs; move ScalarDL 3.11 docs to dedicated version folder #997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds ScalarDL 3.12 documentation to the docs folder as the latest version and moves the ScalarDL 3.11 docs to a versioned folder according to Docusaurus versioning instructions.
- Adds comprehensive Japanese documentation for ScalarDL 3.11 version
- Includes release notes, guides, and reference documentation
- Creates versioned folder structure for documentation management
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
...ned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.11/scalar-kubernetes/BackupNoSQL.mdx
Show resolved
Hide resolved
...ocs/ja-jp/docusaurus-plugin-content-docs/version-3.11/manage-backup-and-restore-overview.mdx
Outdated
Show resolved
Hide resolved
Summary of ChangesHello @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! This pull request primarily focuses on updating the ScalarDL documentation to version 3.12. It involves adding comprehensive new content for ScalarDL HashStore and TableStore, which provide advanced functionalities for managing data authenticity. Concurrently, the previous 3.11 documentation has been systematically archived into a version-specific directory, adhering to Docusaurus versioning best practices. The changes also include important updates to release information, support policies, and refinements to various status codes and configuration guidelines to improve clarity and accuracy. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this 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 a lot of new documentation for ScalarDL 3.12 and versions the 3.11 documentation. The changes are extensive and well-structured. My main feedback is about a recurring formatting issue in the markdown files: the use of ::::
for Docusaurus admonitions instead of the correct :::
. This will cause rendering problems and should be fixed across all new and modified files. I've also pointed out a couple of minor typos in the release notes and a properties file. Overall, this is a great contribution to the documentation.
...rus-plugin-content-docs/version-3.11/applications/simple-bank-account/conf/client.properties
Show resolved
Hide resolved
...docusaurus-plugin-content-docs/version-3.11/helm-charts/configure-custom-values-scalardb.mdx
Show resolved
Hide resolved
...cusaurus-plugin-content-docs/version-3.11/helm-charts/getting-started-scalar-helm-charts.mdx
Show resolved
Hide resolved
...s/ja-jp/docusaurus-plugin-content-docs/version-3.11/how-to-run-applications-with-auditor.mdx
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Description
This PR adds ScalarDB 3.12 docs to the docs folder as the latest version and moves the ScalarDL 3.11 docs to a versioned folder.
Staging site: https://68d3708d0c0162f14c41b1fa--animated-sundae-c9ae14.netlify.app/docs/latest/
Note
Moved the docs according to the Docusaurus versioning instructions.
Related issues and/or PRs
N/A
Changes made
Checklist
Additional notes (optional)
N/A