Skip to content

Commit f7b735c

Browse files
josh-wongjosh-wong
authored
Migrate docs site from Jekyll to Docusaurus (#235)
* Delete Jekyll file * Replace Jekyll ignores with Docusaurus ignores * Add Docusaurus file * Create _translation-ja-jp.mdx * Create product name components * Create unsupported-versions.mdx * Add Scalar brand asset * Move file Move file as part of the migration from Jekyll to Docusaurus. * Create test-deploy.yml This workflow checks if Docusaurus will build and deploy properly in production. * Create deploy.yml * Delete duplicate file We no longer add duplicates to manage latest and versioned docs in two separate folders. * Move file * Rename file * Create empty file as a placeholder * Add image zoom plugin Add the `docusaurus-plugin-image-zoom` plugin to allow for zooming in on images. * Remove styles and asterisks from unsupported versions Keeping styles and asterisks for versions that are no longer supported would require constantly updating the Release Support Policy pages across versions. To avoid this, the styles and asterisks can be removed until we have a better solution. * Add Mermaid diagram plugin and custom styles Add the `@docusaurus/theme-mermaid` plugin to support Mermaid diagrams, and add custom styles. * Delete unnecessary comments * Remove Jekyll-specific language * Change links to absolute links For some reason, using relative links breaks links in this doc. When a visitor clicks a link to a release note, they are taken to the correct release note page. However, if they click the back button to go back to this page and then click a link to a release note, the link is broken because the URL to the release note is incorrect. Changing the relative links to absolute links solves the issue. * Create release-support-policy.md * Add styles for cards * Delete index.md * Create sidebars.js * Delete unsupported-versions.md * Move file * Delete unnecessary file * Delete manage-kubernetes.md Delete this page since it existed only as a stop-gap solution for collapsible side navigation in our previous Jekyll-based docs site. Now that we have collapsible menus, we don't need this page. * Delete deploy-kubernetes.md Delete this page since it existed only as a stop-gap solution for collapsible side navigation in our previous Jekyll-based docs site. Now that we have collapsible menus, we don't need this page. * Change note and tab syntax; change file extension Change the note and tab syntax from Jekyll/Liquid to Docusaurus/React. Also change the file extension from `.md` to `.mdx` so that we can use React components in Markdown docs. * Change note syntax Change the note syntax from Jekyll/Liquid to Docusaurus/React. * Fix links * Update .gitignore * Remove unnecessary redirect * Update package-lock.json * Rename folder * Fix links * Enclose code in backticks Building Docusaurus throws an error when `deleteAllById(Iterable<? extends ID> ids)` is not enclosed in backticks. Basically, these APIs should be enclosed in backticks anyway since they're used within code. * Change file extension from `.md` to `.mdx` To take advantage of React components in Markdown and for those components to render in Docusaurus, the file extension must be `.mdx`. * Remove end-of-support banner This end-of-support banner was specific to Jekyll. Since Docusaurus has a built-in end-of-support (`unmaintained` banner) that can be applied to versions in the Docusaurus configuration file, we'll use that instead. * Remove unnecessary comment Commenting out text by using HTML syntax doesn't work with the `.mdx` file extension and aren't really needed within this doc. * Change comment syntax HTML syntax doesn't work in docs with the `.mdx` file extension, so I've updated it to the supported syntax. * Change warning admonition syntax Change the warning admonition syntax from Jekyll to Docusaurus. * Update name and version * Put docs for configuring custom values in category Put the Helm Charts docs for configuring custom values files in a collapsible category for easier discoverability. * Change syntax from Jekyll/Liquid to Docusaurus/React Change syntax for tabs and admonitions from Jekyll/Liquid to Docusaurus/React. * Add quotation marks to versions Docusaurus throws an error and cannot build the site when a minor version reaches `X.XX`. In our case, the error displayed is `unknown version (3.1) found`. To get around this, we need to add double quotation marks around version numbers. * Add links * Add links * Comment out i18n setting Comment out the i18n setting since we don't have any Japanese docs yet. * Change external links from `.mdx` to `.md` * Delete `index.mdx` This doc is awkward as a landing page, so I think removing it would be better. Instead, for now, the first page that the users sees would then be the `overview.mdx`, which is more detailed. * Delete overview.mdx * Remove index so visitors are directed to overview * Move links; re-name home page link * Re-purpose the home page to show cards * Add styles for cards * Add GitHub icon and link * Change logo link; add GitHub icon and link
1 parent 83b0a49 commit f7b735c

File tree

11,714 files changed

+216781
-352972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

11,714 files changed

+216781
-352972
lines changed

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
> 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.
1616
17-
- [ ] I have updated the side navigation (`_data/navigation.yml`) as necessary.
17+
- [ ] I have updated the side navigation as necessary.
1818
- [ ] I have commented my code, particularly in hard-to-understand areas.
1919
- [ ] I have updated the documentation to reflect the changes.
2020
- [ ] Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).

‎.github/workflows/deploy.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
workflow_dispatch:
10+
11+
jobs:
12+
build:
13+
name: Build Docusaurus
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 18
22+
cache: npm
23+
24+
- name: Install dependencies
25+
run: npm ci
26+
- name: Build website
27+
run: npm run build
28+
29+
- name: Upload Build Artifact
30+
uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: build
33+
34+
deploy:
35+
name: Deploy to GitHub Pages
36+
needs: build
37+
38+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
39+
permissions:
40+
pages: write # to deploy to Pages
41+
id-token: write # to verify the deployment originates from an appropriate source
42+
43+
# Deploy to the github-pages environment
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
48+
runs-on: ubuntu-latest
49+
steps:
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

‎.github/workflows/jekyll.yml‎

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎.github/workflows/test-deploy.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Test deployment
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
workflow_dispatch:
10+
11+
jobs:
12+
test-deploy:
13+
name: Test deployment
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 18
22+
cache: npm
23+
24+
- name: Install dependencies
25+
run: npm ci
26+
- name: Test build website
27+
run: npm run build

‎.gitignore‎

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,27 @@
1-
# Vim
2-
*~
3-
*.sw[p_]
1+
# Dependencies
2+
/node_modules
43

5-
# Sublime Text
6-
*.sublime-project
7-
*.sublime-workspace
4+
# Production
5+
/build
86

9-
# Ruby Gem
10-
*.gem
11-
.bundle
12-
Gemfile.lock
13-
**/vendor/bundle
14-
15-
# Node.js and NPM
16-
node_modules
17-
npm-debug.log*
18-
package-lock.json
19-
codekit-config.json
20-
21-
# macOS
22-
.DS_Store
23-
24-
# Jekyll generated files
25-
.jekyll-cache
26-
.jekyll-metadata
27-
.sass-cache
28-
_asset_bundler_cache
29-
_site
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
3010

3111
# Gradle build files
3212
.gradle
3313

3414
# IntelliJ IDEA
3515
.idea
16+
17+
# Misc
18+
.DS_Store
19+
.env.local
20+
.env.development.local
21+
.env.test.local
22+
.env.production.local
23+
npm-debug.log*
24+
yarn-debug.log*
25+
yarn-error.log*
26+
**/scalardb-samples/**/package-lock.json
27+
*.drawio

‎Gemfile‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)