From e0681a4f58ad2fe921a51e89eb411fbce4be5476 Mon Sep 17 00:00:00 2001 From: Felix Angelov Date: Fri, 11 Oct 2024 14:41:07 -0500 Subject: [PATCH] docs: move overview section into code push group (#304) --- astro.config.mjs | 47 +++++++++---------- src/content/docs/code-push/initialize.mdx | 2 +- src/content/docs/{ => code-push}/overview.mdx | 3 ++ src/content/docs/code-push/patch.mdx | 2 +- src/content/docs/code-push/preview.mdx | 2 +- src/content/docs/code-push/release.mdx | 2 +- src/content/docs/code-push/rollback.mdx | 2 +- src/content/docs/faq.mdx | 4 +- src/content/docs/update-strategies.mdx | 2 +- 9 files changed, 33 insertions(+), 33 deletions(-) rename src/content/docs/{ => code-push}/overview.mdx (99%) diff --git a/astro.config.mjs b/astro.config.mjs index 64c1d5c0..07d81db4 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -55,10 +55,6 @@ export default defineConfig({ label: 'Getting Started', link: '/', }, - { - label: 'Overview', - link: '/overview', - }, { label: 'Code Push', autogenerate: { @@ -163,26 +159,27 @@ export default defineConfig({ }, redirects: { // Redirects to preserve legacy URLs. - ci: '/ci/github', - 'code_push/initialize': 'code-push/initialize/', - 'code_push/patch': 'code-push/patch/', - 'code_push/preview': 'code-push/preview/', - 'code_push/release': 'code-push/release/', - 'code_push/run': 'code-push/preview', - guides: '/', - 'guides/add-to-app/ios': 'guides/hybrid-apps/ios', - 'guides/code_push_add_to_app': 'guides/hybrid-apps/android', - 'guides/code_push_quickstart': 'guides/code-push-quickstart', - 'guides/crash-reporting': 'guides/crash-reporting/uploading-symbols', - 'guides/fastlane': 'ci/fastlane', - 'guides/flavors': 'guides/flavors/android', - 'guides/code-push-quickstart': '/', - 'guides/hybrid-app': 'guides/hybrid-apps/android', - 'guides/hybrid-app/android': 'guides/hybrid-apps/android', - 'guides/hybrid-app/ios': 'guides/hybrid-apps/ios', - 'guides/release/android': 'guides/submitting/play-store', - 'guides/release/ios': 'guides/submitting/app-store', - concepts: 'overview', - teams: 'orgs', + '/ci': '/ci/github', + '/code_push/initialize': 'code-push/initialize/', + '/code_push/patch': 'code-push/patch/', + '/code_push/preview': 'code-push/preview/', + '/code_push/release': 'code-push/release/', + '/code_push/run': 'code-push/preview', + '/concepts': '/code-push/overview', + '/guides': '/', + '/guides/add-to-app/ios': 'guides/hybrid-apps/ios', + '/guides/code_push_add_to_app': 'guides/hybrid-apps/android', + '/guides/code_push_quickstart': 'guides/code-push-quickstart', + '/guides/crash-reporting': 'guides/crash-reporting/uploading-symbols', + '/guides/fastlane': 'ci/fastlane', + '/guides/flavors': 'guides/flavors/android', + '/guides/code-push-quickstart': '/', + '/guides/hybrid-app': 'guides/hybrid-apps/android', + '/guides/hybrid-app/android': 'guides/hybrid-apps/android', + '/guides/hybrid-app/ios': 'guides/hybrid-apps/ios', + '/guides/release/android': 'guides/submitting/play-store', + '/guides/release/ios': 'guides/submitting/app-store', + '/overview': '/code-push/overview', + '/teams': 'orgs', }, }); diff --git a/src/content/docs/code-push/initialize.mdx b/src/content/docs/code-push/initialize.mdx index a208a592..06c94fdf 100644 --- a/src/content/docs/code-push/initialize.mdx +++ b/src/content/docs/code-push/initialize.mdx @@ -3,7 +3,7 @@ title: Initialize Shorebird description: Learn how to add code push to an existing Flutter project. sidebar: label: Initialize - order: 1 + order: 2 --- To configure an existing Flutter project to use Shorebird, use `shorebird init` diff --git a/src/content/docs/overview.mdx b/src/content/docs/code-push/overview.mdx similarity index 99% rename from src/content/docs/overview.mdx rename to src/content/docs/code-push/overview.mdx index 5cb264b4..6ccdb2a2 100644 --- a/src/content/docs/overview.mdx +++ b/src/content/docs/code-push/overview.mdx @@ -1,6 +1,9 @@ --- title: Overview description: A high-level explanation of what Code Push is and how it works. +sidebar: + label: Overview + order: 1 --- ## What is Code Push? diff --git a/src/content/docs/code-push/patch.mdx b/src/content/docs/code-push/patch.mdx index 7c5c0cd0..a5dfab2c 100644 --- a/src/content/docs/code-push/patch.mdx +++ b/src/content/docs/code-push/patch.mdx @@ -3,7 +3,7 @@ title: Create a Patch description: Learn how to push updates to an app with Shorebird. sidebar: label: Patch - order: 4 + order: 5 --- import { Tabs, TabItem } from '@astrojs/starlight/components'; diff --git a/src/content/docs/code-push/preview.mdx b/src/content/docs/code-push/preview.mdx index 7cc81377..417015ae 100644 --- a/src/content/docs/code-push/preview.mdx +++ b/src/content/docs/code-push/preview.mdx @@ -3,7 +3,7 @@ title: Preview Locally description: Learn how to preview an existing release of your application. sidebar: label: Preview - order: 3 + order: 4 --- Once you have [created a release](/code-push/release), you can preview your diff --git a/src/content/docs/code-push/release.mdx b/src/content/docs/code-push/release.mdx index d1684c6a..0ae199a7 100644 --- a/src/content/docs/code-push/release.mdx +++ b/src/content/docs/code-push/release.mdx @@ -3,7 +3,7 @@ title: Create a Release description: Learn how to publish a new app release to Shorebird. sidebar: label: Release - order: 2 + order: 3 --- import { Tabs, TabItem } from '@astrojs/starlight/components'; diff --git a/src/content/docs/code-push/rollback.mdx b/src/content/docs/code-push/rollback.mdx index 54efbe76..c36ceb1c 100644 --- a/src/content/docs/code-push/rollback.mdx +++ b/src/content/docs/code-push/rollback.mdx @@ -3,7 +3,7 @@ title: Roll back a Patch description: Learn how to roll back a patch in Shorebird. sidebar: label: Rollback - order: 5 + order: 6 --- If you discover that a live patch has a bug, Shorebird supports patch roll back. diff --git a/src/content/docs/faq.mdx b/src/content/docs/faq.mdx index ed075b4c..35214149 100644 --- a/src/content/docs/faq.mdx +++ b/src/content/docs/faq.mdx @@ -20,7 +20,7 @@ update it to new code. The `shorebird patch` command is used to generate a patch from your new local code which is then diffed with the release binary to generate a patch which is then shipped to your users. -We explain more of these terms in [Overview](/overview). +We explain more of these terms in [Overview](/code-push/overview). ### Can I use Shorebird in my country? @@ -197,7 +197,7 @@ for you, please let us know! Yes. There is no limit on the size of the application that can be patched with code push. As noted in -[Overview](/overview#what-types-of-changes-can-be-included-in-a-patch), +[Overview](/code-push/overview#what-types-of-changes-can-be-included-in-a-patch), Shorebird can change any Dart code in your application no matter of size. ### What can I use Shorebird code push for? diff --git a/src/content/docs/update-strategies.mdx b/src/content/docs/update-strategies.mdx index 2e60696e..fd91081c 100644 --- a/src/content/docs/update-strategies.mdx +++ b/src/content/docs/update-strategies.mdx @@ -79,7 +79,7 @@ necessary patch and _not_ then prompt them to update. Shorebird patches are typically much smaller than full app downloads (a few KB on Android, a few hundred KB on iOS), so it is likely better for your users if you can use Shorebird to deliver patches instead of `in_app_update`. However, -there are [changes which Shorebird cannot make](/overview#what-types-of-changes-can-be-included-in-a-patch), so +there are [changes which Shorebird cannot make](/code-push/overview#what-types-of-changes-can-be-included-in-a-patch), so `in_app_update` may be the best solution in some cases. Shorebird "patches" also do not change the version number of your app, so