diff --git a/docs/03-github-cloud-runner/01-introduction.md b/docs/03-github-cloud-runner/01-introduction.mdx similarity index 100% rename from docs/03-github-cloud-runner/01-introduction.md rename to docs/03-github-cloud-runner/01-introduction.mdx diff --git a/docs/03-github-cloud-runner/02-game-ci-vs-cloud-runner.md b/docs/03-github-cloud-runner/02-game-ci-vs-cloud-runner.mdx similarity index 100% rename from docs/03-github-cloud-runner/02-game-ci-vs-cloud-runner.md rename to docs/03-github-cloud-runner/02-game-ci-vs-cloud-runner.mdx diff --git a/docs/03-github-cloud-runner/02-getting-started/aws.md b/docs/03-github-cloud-runner/02-getting-started/aws.mdx similarity index 100% rename from docs/03-github-cloud-runner/02-getting-started/aws.md rename to docs/03-github-cloud-runner/02-getting-started/aws.mdx diff --git a/docs/03-github-cloud-runner/02-getting-started/kubernetes.md b/docs/03-github-cloud-runner/02-getting-started/kubernetes.mdx similarity index 100% rename from docs/03-github-cloud-runner/02-getting-started/kubernetes.md rename to docs/03-github-cloud-runner/02-getting-started/kubernetes.mdx diff --git a/docs/03-github-cloud-runner/03-configuration.md b/docs/03-github-cloud-runner/03-configuration.mdx similarity index 100% rename from docs/03-github-cloud-runner/03-configuration.md rename to docs/03-github-cloud-runner/03-configuration.mdx diff --git a/docs/03-github-cloud-runner/04-command-line.md b/docs/03-github-cloud-runner/04-command-line.mdx similarity index 100% rename from docs/03-github-cloud-runner/04-command-line.md rename to docs/03-github-cloud-runner/04-command-line.mdx diff --git a/docs/03-github-cloud-runner/06-development.md b/docs/03-github-cloud-runner/06-development.mdx similarity index 100% rename from docs/03-github-cloud-runner/06-development.md rename to docs/03-github-cloud-runner/06-development.mdx diff --git a/docs/03-github/02-activation.md b/docs/03-github/02-activation.mdx similarity index 100% rename from docs/03-github/02-activation.md rename to docs/03-github/02-activation.mdx diff --git a/docs/03-github/03-test-runner.md b/docs/03-github/03-test-runner.mdx similarity index 100% rename from docs/03-github/03-test-runner.md rename to docs/03-github/03-test-runner.mdx diff --git a/docs/03-github/04-builder.md b/docs/03-github/04-builder.mdx similarity index 100% rename from docs/03-github/04-builder.md rename to docs/03-github/04-builder.mdx diff --git a/docs/03-github/05-returning-a-license.md b/docs/03-github/05-returning-a-license.mdx similarity index 100% rename from docs/03-github/05-returning-a-license.md rename to docs/03-github/05-returning-a-license.mdx diff --git a/docs/03-github/deployment/_category_.yaml b/docs/03-github/06-deployment/_category_.yaml similarity index 80% rename from docs/03-github/deployment/_category_.yaml rename to docs/03-github/06-deployment/_category_.yaml index b6da4dce..f74a60fd 100644 --- a/docs/03-github/deployment/_category_.yaml +++ b/docs/03-github/06-deployment/_category_.yaml @@ -1,5 +1,5 @@ --- -position: 5.0 +position: 6.0 label: Deployment collapsible: true collapsed: true diff --git a/docs/03-github/deployment/android.md b/docs/03-github/06-deployment/android.mdx similarity index 100% rename from docs/03-github/deployment/android.md rename to docs/03-github/06-deployment/android.mdx diff --git a/docs/03-github/deployment/ios.md b/docs/03-github/06-deployment/ios.mdx similarity index 100% rename from docs/03-github/deployment/ios.md rename to docs/03-github/06-deployment/ios.mdx diff --git a/docs/03-github/deployment/steam.md b/docs/03-github/06-deployment/steam.mdx similarity index 100% rename from docs/03-github/deployment/steam.md rename to docs/03-github/06-deployment/steam.mdx diff --git a/docs/05-gitlab/02-activation.md b/docs/05-gitlab/02-activation.mdx similarity index 100% rename from docs/05-gitlab/02-activation.md rename to docs/05-gitlab/02-activation.mdx diff --git a/docs/05-gitlab/03-example-project.md b/docs/05-gitlab/03-example-project.mdx similarity index 100% rename from docs/05-gitlab/03-example-project.md rename to docs/05-gitlab/03-example-project.mdx diff --git a/docs/05-gitlab/custom-build-options.md b/docs/05-gitlab/04-custom-build-options.mdx similarity index 100% rename from docs/05-gitlab/custom-build-options.md rename to docs/05-gitlab/04-custom-build-options.mdx diff --git a/docs/05-gitlab/tests.md b/docs/05-gitlab/05-tests.mdx similarity index 100% rename from docs/05-gitlab/tests.md rename to docs/05-gitlab/05-tests.mdx diff --git a/docs/05-gitlab/deployment/_category_.yaml b/docs/05-gitlab/06-deployment/_category_.yaml similarity index 80% rename from docs/05-gitlab/deployment/_category_.yaml rename to docs/05-gitlab/06-deployment/_category_.yaml index 76f9064b..f74a60fd 100644 --- a/docs/05-gitlab/deployment/_category_.yaml +++ b/docs/05-gitlab/06-deployment/_category_.yaml @@ -1,5 +1,5 @@ --- -position: 5 +position: 6.0 label: Deployment collapsible: true collapsed: true diff --git a/docs/05-gitlab/deployment/android.md b/docs/05-gitlab/06-deployment/android.mdx similarity index 100% rename from docs/05-gitlab/deployment/android.md rename to docs/05-gitlab/06-deployment/android.mdx diff --git a/docs/05-gitlab/deployment/ios.md b/docs/05-gitlab/06-deployment/ios.mdx similarity index 100% rename from docs/05-gitlab/deployment/ios.md rename to docs/05-gitlab/06-deployment/ios.mdx diff --git a/docs/08-docker/01-docker-images.md b/docs/08-docker/01-docker-images.mdx similarity index 100% rename from docs/08-docker/01-docker-images.md rename to docs/08-docker/01-docker-images.mdx diff --git a/docs/08-docker/02-windows-docker-images.md b/docs/08-docker/02-windows-docker-images.mdx similarity index 100% rename from docs/08-docker/02-windows-docker-images.md rename to docs/08-docker/02-windows-docker-images.mdx diff --git a/docs/08-docker/03-customize-docker-images.md b/docs/08-docker/03-customize-docker-images.mdx similarity index 100% rename from docs/08-docker/03-customize-docker-images.md rename to docs/08-docker/03-customize-docker-images.mdx diff --git a/docs/08-docker/04-versions.mdx b/docs/08-docker/04-versions.mdx new file mode 100644 index 00000000..0c8b1405 --- /dev/null +++ b/docs/08-docker/04-versions.mdx @@ -0,0 +1 @@ +# Versions diff --git a/docs/09-troubleshooting/common-issues.md b/docs/09-troubleshooting/common-issues.mdx similarity index 100% rename from docs/09-troubleshooting/common-issues.md rename to docs/09-troubleshooting/common-issues.mdx diff --git a/versioned_docs/version-1/intro.md b/docs/index.mdx similarity index 96% rename from versioned_docs/version-1/intro.md rename to docs/index.mdx index 804ab1ca..6e0306c8 100644 --- a/versioned_docs/version-1/intro.md +++ b/docs/index.mdx @@ -1,8 +1,9 @@ --- sidebar_position: 1 -title: Welcome to GameCI --- +# Introduction + This site hosts all documentation for GameCI, and will help you setup Continuous Integration for your game projects. Continuous Integration is a widely-used practice where automated pipelines check the diff --git a/docusaurus.config.js b/docusaurus.config.js index 3b1e1cdf..d4096f20 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -112,7 +112,7 @@ const config = { items: [ { type: 'doc', - docId: 'introduction/index', + docId: 'index', position: 'left', label: 'Docs', }, @@ -193,7 +193,7 @@ const config = { items: [ { label: 'Welcome to GameCI', - to: '/docs/introduction/index', + to: '/docs/index', }, { label: 'Getting Started with Github', diff --git a/sidebars.js b/sidebars.js index 54ba6094..65ecc5ce 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,31 +1,6 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - { - type: 'category', - label: 'Tutorial', - items: ['hello'], - }, - ], - */ +module.exports = { + defaultSidebar: [{ type: 'autogenerated', dirName: '.' }], }; - -module.exports = sidebars; diff --git a/versioned_docs/version-1/02-introduction/getting-started.md b/versioned_docs/version-1/02-getting-started/index.mdx similarity index 100% rename from versioned_docs/version-1/02-introduction/getting-started.md rename to versioned_docs/version-1/02-getting-started/index.mdx diff --git a/versioned_docs/version-1/03-docker/01-docker-images.md b/versioned_docs/version-1/03-docker/01-docker-images.mdx similarity index 100% rename from versioned_docs/version-1/03-docker/01-docker-images.md rename to versioned_docs/version-1/03-docker/01-docker-images.mdx diff --git a/versioned_docs/version-1/03-docker/02-windows-docker-images.md b/versioned_docs/version-1/03-docker/02-windows-docker-images.mdx similarity index 100% rename from versioned_docs/version-1/03-docker/02-windows-docker-images.md rename to versioned_docs/version-1/03-docker/02-windows-docker-images.mdx diff --git a/versioned_docs/version-1/03-docker/03-customize-docker-images.md b/versioned_docs/version-1/03-docker/03-customize-docker-images.mdx similarity index 100% rename from versioned_docs/version-1/03-docker/03-customize-docker-images.md rename to versioned_docs/version-1/03-docker/03-customize-docker-images.mdx diff --git a/versioned_docs/version-1/03-docker/_category_.yaml b/versioned_docs/version-1/03-docker/_category_.yaml new file mode 100644 index 00000000..185d8aa9 --- /dev/null +++ b/versioned_docs/version-1/03-docker/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 3.0 +label: Docker +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/04-github/01-getting-started.md b/versioned_docs/version-1/04-github/01-getting-started.mdx similarity index 100% rename from versioned_docs/version-1/04-github/01-getting-started.md rename to versioned_docs/version-1/04-github/01-getting-started.mdx diff --git a/versioned_docs/version-1/04-github/02-activation.md b/versioned_docs/version-1/04-github/02-activation.mdx similarity index 100% rename from versioned_docs/version-1/04-github/02-activation.md rename to versioned_docs/version-1/04-github/02-activation.mdx diff --git a/versioned_docs/version-1/04-github/03-test-runner.md b/versioned_docs/version-1/04-github/03-test-runner.mdx similarity index 100% rename from versioned_docs/version-1/04-github/03-test-runner.md rename to versioned_docs/version-1/04-github/03-test-runner.mdx diff --git a/versioned_docs/version-1/04-github/04-builder.md b/versioned_docs/version-1/04-github/04-builder.mdx similarity index 100% rename from versioned_docs/version-1/04-github/04-builder.md rename to versioned_docs/version-1/04-github/04-builder.mdx diff --git a/versioned_docs/version-1/04-github/05-returning-a-license.md b/versioned_docs/version-1/04-github/05-returning-a-license.mdx similarity index 100% rename from versioned_docs/version-1/04-github/05-returning-a-license.md rename to versioned_docs/version-1/04-github/05-returning-a-license.mdx diff --git a/versioned_docs/version-1/04-github/06-deployment/_category_.yaml b/versioned_docs/version-1/04-github/06-deployment/_category_.yaml new file mode 100644 index 00000000..f74a60fd --- /dev/null +++ b/versioned_docs/version-1/04-github/06-deployment/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 6.0 +label: Deployment +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/04-github/06-deployment/android.md b/versioned_docs/version-1/04-github/06-deployment/android.mdx similarity index 100% rename from versioned_docs/version-1/04-github/06-deployment/android.md rename to versioned_docs/version-1/04-github/06-deployment/android.mdx diff --git a/versioned_docs/version-1/04-github/06-deployment/ios.md b/versioned_docs/version-1/04-github/06-deployment/ios.mdx similarity index 100% rename from versioned_docs/version-1/04-github/06-deployment/ios.md rename to versioned_docs/version-1/04-github/06-deployment/ios.mdx diff --git a/versioned_docs/version-1/04-github/_category_.yaml b/versioned_docs/version-1/04-github/_category_.yaml new file mode 100644 index 00000000..0d39fae2 --- /dev/null +++ b/versioned_docs/version-1/04-github/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 4.0 +label: GitHub +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/05-gitlab/01-getting-started.md b/versioned_docs/version-1/05-gitlab/01-getting-started.mdx similarity index 95% rename from versioned_docs/version-1/05-gitlab/01-getting-started.md rename to versioned_docs/version-1/05-gitlab/01-getting-started.mdx index 8db0260a..64b93be5 100644 --- a/versioned_docs/version-1/05-gitlab/01-getting-started.md +++ b/versioned_docs/version-1/05-gitlab/01-getting-started.mdx @@ -24,7 +24,13 @@ It's generally considered good practice to use the same Unity version for your C ## Video tutorial - + ## Setting up gitlab-ci for your Unity project diff --git a/versioned_docs/version-1/05-gitlab/02-activation.md b/versioned_docs/version-1/05-gitlab/02-activation.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/02-activation.md rename to versioned_docs/version-1/05-gitlab/02-activation.mdx diff --git a/versioned_docs/version-1/05-gitlab/03-example-project.md b/versioned_docs/version-1/05-gitlab/03-example-project.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/03-example-project.md rename to versioned_docs/version-1/05-gitlab/03-example-project.mdx diff --git a/versioned_docs/version-1/05-gitlab/custom-build-options.md b/versioned_docs/version-1/05-gitlab/04-custom-build-options.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/custom-build-options.md rename to versioned_docs/version-1/05-gitlab/04-custom-build-options.mdx diff --git a/versioned_docs/version-1/05-gitlab/tests.md b/versioned_docs/version-1/05-gitlab/05-tests.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/tests.md rename to versioned_docs/version-1/05-gitlab/05-tests.mdx diff --git a/versioned_docs/version-1/05-gitlab/06-deployment/_category_.yaml b/versioned_docs/version-1/05-gitlab/06-deployment/_category_.yaml new file mode 100644 index 00000000..f74a60fd --- /dev/null +++ b/versioned_docs/version-1/05-gitlab/06-deployment/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 6.0 +label: Deployment +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/05-gitlab/deployment/android.md b/versioned_docs/version-1/05-gitlab/06-deployment/android.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/deployment/android.md rename to versioned_docs/version-1/05-gitlab/06-deployment/android.mdx diff --git a/versioned_docs/version-1/05-gitlab/deployment/ios.md b/versioned_docs/version-1/05-gitlab/06-deployment/ios.mdx similarity index 100% rename from versioned_docs/version-1/05-gitlab/deployment/ios.md rename to versioned_docs/version-1/05-gitlab/06-deployment/ios.mdx diff --git a/versioned_docs/version-1/05-gitlab/_category_.yaml b/versioned_docs/version-1/05-gitlab/_category_.yaml new file mode 100644 index 00000000..d82551f7 --- /dev/null +++ b/versioned_docs/version-1/05-gitlab/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 5.0 +label: GitLab +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/06-troubleshooting/_category_.yaml b/versioned_docs/version-1/06-troubleshooting/_category_.yaml new file mode 100644 index 00000000..1e43d670 --- /dev/null +++ b/versioned_docs/version-1/06-troubleshooting/_category_.yaml @@ -0,0 +1,5 @@ +--- +position: 6.0 +label: Troubleshooting +collapsible: true +collapsed: true diff --git a/versioned_docs/version-1/06-troubleshooting/common-issues.md b/versioned_docs/version-1/06-troubleshooting/common-issues.mdx similarity index 100% rename from versioned_docs/version-1/06-troubleshooting/common-issues.md rename to versioned_docs/version-1/06-troubleshooting/common-issues.mdx diff --git a/docs/01-introduction/index.mdx b/versioned_docs/version-1/index.mdx similarity index 96% rename from docs/01-introduction/index.mdx rename to versioned_docs/version-1/index.mdx index 9111fe42..6e0306c8 100644 --- a/docs/01-introduction/index.mdx +++ b/versioned_docs/version-1/index.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Introduction This site hosts all documentation for GameCI, and will help you setup Continuous Integration for your game projects. diff --git a/versioned_sidebars/version-1-sidebars.json b/versioned_sidebars/version-1-sidebars.json index caea0c03..01dc4a0a 100644 --- a/versioned_sidebars/version-1-sidebars.json +++ b/versioned_sidebars/version-1-sidebars.json @@ -1,8 +1,3 @@ { - "tutorialSidebar": [ - { - "type": "autogenerated", - "dirName": "." - } - ] + "defaultSidebar": [{ "type": "autogenerated", "dirName": "." }] }