Skip to content
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

Add ScalarDL 3.10 docs; move ScalarDL 3.9 docs to dedicated version folder #595

Merged
merged 27 commits into from
Dec 4, 2024

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Dec 3, 2024

Caution

This PR can be merged after ScalarDL 3.10 has been officially released.

Description

This PR moves the ScalarDL 3.9 docs to a versioned folder and adds ScalarDB 3.10 docs to the docs folder as the latest version.

Related issues and/or PRs

N/A

Changes made

  • English docs
    • Moved 3.9 docs to the versioned_docs/version-3.9 folder.
    • Added 3.10 docs to the docs folder, which is where the latest version of English docs lives.
    • Added release notes.
    • Updated the Release Support Policy.
  • Japanese docs
    • Moved 3.9 docs to the i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9 folder.
    • Added 3.10 docs to the *i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current folder, which is where the latest version of Japanese docs lives.
    • Added release notes.
    • Updated the Release Support Policy.
  • Created a dedicated sidebar navigation for 3.9 (versioned_sidebars/version-3.9-sidebars.json)3.9 version sidebar from sidebars.js to 3.9.json andGenerated sidebarsMoved docs for 3.9 into a version folder, according to the Docusaurus versioning instructions.
  • Added an announcement to the top of the docs site about the 3.10 release

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 added the documentation Improvements or additions to documentation label Dec 3, 2024
@josh-wong josh-wong self-assigned this Dec 3, 2024
Since this PR adds 3.10 docs as the latest version, this file for 3.9, which was previously the latest version, needs to be updated
Update the URL to the Card component since this PR adds 3.10 docs as the latest version.
Since this PR adds 3.10 docs as the latest version, this file for 3.9, which was previously the latest version, needs to be updated.
@josh-wong josh-wong marked this pull request as ready for review December 4, 2024 09:46
Copy link

netlify bot commented Dec 4, 2024

Deploy Preview for staging-scalardl-docs-site ready!

Name Link
🔨 Latest commit 8843b96
🔍 Latest deploy log https://app.netlify.com/sites/staging-scalardl-docs-site/deploys/67502c139f5c1a00082ec2d3
😎 Deploy Preview https://deploy-preview-595--staging-scalardl-docs-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 80
Accessibility: 97
Best Practices: 92
SEO: 96
PWA: 90
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@josh-wong josh-wong force-pushed the prepare-version-3.10 branch from 3c89bd9 to 25bb440 Compare December 4, 2024 10:05
@josh-wong josh-wong merged commit 366b16f into main Dec 4, 2024
5 checks passed
@josh-wong josh-wong deleted the prepare-version-3.10 branch December 4, 2024 10:29
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