From b743a99bf7781842c7b0dd57460bf40bcc53b0d4 Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Thu, 8 Aug 2024 17:25:12 -0400
Subject: [PATCH 1/5] Rename "Releasing" to "Submitting"
---
astro.config.mjs | 18 ++++++++++--------
.../ios.mdx => submitting/app_store.mdx} | 2 +-
.../android.mdx => submitting/play_store.mdx} | 2 +-
3 files changed, 12 insertions(+), 10 deletions(-)
rename src/content/docs/guides/{release/ios.mdx => submitting/app_store.mdx} (99%)
rename src/content/docs/guides/{release/android.mdx => submitting/play_store.mdx} (99%)
diff --git a/astro.config.mjs b/astro.config.mjs
index 16e27dd4..b537afad 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -72,10 +72,8 @@ export default defineConfig({
link: '/guides/code-push-quickstart',
},
{
- label: 'Release',
- autogenerate: {
- directory: 'guides/release',
- },
+ label: 'Crash Reporting',
+ link: '/guides/crash-reporting',
},
{
label: 'Staging Patches',
@@ -92,14 +90,16 @@ export default defineConfig({
},
},
{
- label: 'Hybrid Apps',
+ label: 'Submitting to the Stores',
autogenerate: {
- directory: 'guides/hybrid-apps',
+ directory: 'guides/submitting',
},
},
{
- label: 'Crash Reporting',
- link: '/guides/crash-reporting',
+ label: 'Hybrid Apps',
+ autogenerate: {
+ directory: 'guides/hybrid-apps',
+ },
},
],
},
@@ -182,5 +182,7 @@ export default defineConfig({
'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',
},
});
diff --git a/src/content/docs/guides/release/ios.mdx b/src/content/docs/guides/submitting/app_store.mdx
similarity index 99%
rename from src/content/docs/guides/release/ios.mdx
rename to src/content/docs/guides/submitting/app_store.mdx
index 48567cc5..16e11e3b 100644
--- a/src/content/docs/guides/release/ios.mdx
+++ b/src/content/docs/guides/submitting/app_store.mdx
@@ -2,7 +2,7 @@
title: Releasing to the Apple App Store
description: Release a Code Push App to the Apple App Store
sidebar:
- label: iOS
+ label: App Store
order: 2
---
diff --git a/src/content/docs/guides/release/android.mdx b/src/content/docs/guides/submitting/play_store.mdx
similarity index 99%
rename from src/content/docs/guides/release/android.mdx
rename to src/content/docs/guides/submitting/play_store.mdx
index b32778dc..2cbb7414 100644
--- a/src/content/docs/guides/release/android.mdx
+++ b/src/content/docs/guides/submitting/play_store.mdx
@@ -2,7 +2,7 @@
title: Releasing to the Google Play Store
description: Release a Code Push App to the Google Play Store
sidebar:
- label: Android
+ label: Play Store
order: 1
---
From c0b8e95486867632c84d87549e4c78e14e38a8c5 Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Thu, 8 Aug 2024 17:29:23 -0400
Subject: [PATCH 2/5] fix links
---
src/content/docs/guides/flavors/android.mdx | 6 +++++-
src/content/docs/guides/flavors/ios.mdx | 6 +++++-
src/content/docs/guides/staging-patches.mdx | 4 +++-
src/content/docs/troubleshooting.mdx | 10 +++++-----
4 files changed, 18 insertions(+), 8 deletions(-)
diff --git a/src/content/docs/guides/flavors/android.mdx b/src/content/docs/guides/flavors/android.mdx
index dbde0d18..2a7ab834 100644
--- a/src/content/docs/guides/flavors/android.mdx
+++ b/src/content/docs/guides/flavors/android.mdx
@@ -112,7 +112,11 @@ shorebird preview --app-id 904bd3d5-3526-4c1c-a832-7ac23c95302d --release-versio
This will download the releases and run them on your device.
-In addition to previewing the releases locally, you should also [submit the generated app bundles to the Play Store](/guides/release/android#upload-to-the-play-store). In this case, both apps can be part of the internal test flavor and only the stable variant should be promoted to production.
+In addition to previewing the releases locally, you should also [submit the
+generated app bundles to the Play
+Store](/guides/submitting/play-store#upload-to-the-play-store). In this case, both
+apps can be part of the internal test flavor and only the stable variant should
+be promoted to production.
:::note
diff --git a/src/content/docs/guides/flavors/ios.mdx b/src/content/docs/guides/flavors/ios.mdx
index 1fb59ddb..61b80cb1 100644
--- a/src/content/docs/guides/flavors/ios.mdx
+++ b/src/content/docs/guides/flavors/ios.mdx
@@ -81,7 +81,11 @@ shorebird preview --app-id 904bd3d5-3526-4c1c-a832-7ac23c95302d --release-versio
This will download the releases and run them on your device.
-In addition to previewing the releases locally, you should also [submit the generated app bundles to the App Store](/guides/release/ios#upload-to-the-app-store). In this case, both apps can be part of the internal test flavor and only the stable variant should be promoted to production.
+In addition to previewing the releases locally, you should also [submit the
+generated app bundles to the App
+Store](/guides/submitting/app-store#upload-to-the-app-store). In this case, both apps can
+be part of the internal test flavor and only the stable variant should be
+promoted to production.
:::note
diff --git a/src/content/docs/guides/staging-patches.mdx b/src/content/docs/guides/staging-patches.mdx
index 44624694..d47d9c92 100644
--- a/src/content/docs/guides/staging-patches.mdx
+++ b/src/content/docs/guides/staging-patches.mdx
@@ -54,7 +54,9 @@ shorebird release ios
We can verify the releases were created successfully by visiting [Shorebird console](https://console.shorebird.dev).
-You should also [submit the generated app bundles to the Play Store](/guides/release/android#upload-to-the-play-store) and [submit the generated ipa to the App Store](/guides/release/ios#upload-to-the-app-store).
+You should also [submit the generated app bundles to the Play
+Store](/guides/submitting/play-store#upload-to-the-play-store) and [submit the
+generated ipa to the App Store](/guides/submitting/app-store#upload-to-the-app-store).
## Creating a patch
diff --git a/src/content/docs/troubleshooting.mdx b/src/content/docs/troubleshooting.mdx
index 262748fc..aa4107db 100644
--- a/src/content/docs/troubleshooting.mdx
+++ b/src/content/docs/troubleshooting.mdx
@@ -19,11 +19,11 @@ Patches are only compatible with the release version they were created for. If
you create a patch for version `1.0.0+1`, it will not work on version `1.0.0+2`.
:::note
-This can happen unexpectedly on iOS due to Xcode's automatic incrementing of
-build numbers. If you are seeing this issue on iOS, ensure that the build number
-of the release and the patch match. See [our iOS releasing
-guide](/guides/release/ios/#upload-to-the-app-store) for instructions on how to
-disable automatic build number incrementing.
+This can happen unexpectedly on iOS due to Xcode's automatic
+incrementing of build numbers. If you are seeing this issue on iOS, ensure that
+the build number of the release and the patch match. See [our iOS releasing
+guide](/guides/submitting/app-store/#upload-to-the-app-store) for instructions
+on how to disable automatic build number incrementing.
:::
#### How to tell if this is the problem
From c714e1ea1c96587741f8490d0a5f8910fe1cbe3b Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Thu, 8 Aug 2024 17:31:17 -0400
Subject: [PATCH 3/5] use dashes for file names
---
.../docs/guides/submitting/{app_store.mdx => app-store.mdx} | 0
.../docs/guides/submitting/{play_store.mdx => play-store.mdx} | 0
2 files changed, 0 insertions(+), 0 deletions(-)
rename src/content/docs/guides/submitting/{app_store.mdx => app-store.mdx} (100%)
rename src/content/docs/guides/submitting/{play_store.mdx => play-store.mdx} (100%)
diff --git a/src/content/docs/guides/submitting/app_store.mdx b/src/content/docs/guides/submitting/app-store.mdx
similarity index 100%
rename from src/content/docs/guides/submitting/app_store.mdx
rename to src/content/docs/guides/submitting/app-store.mdx
diff --git a/src/content/docs/guides/submitting/play_store.mdx b/src/content/docs/guides/submitting/play-store.mdx
similarity index 100%
rename from src/content/docs/guides/submitting/play_store.mdx
rename to src/content/docs/guides/submitting/play-store.mdx
From 57d589be48f4d56717f455de6f50b63a6419b56d Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Thu, 8 Aug 2024 17:31:37 -0400
Subject: [PATCH 4/5] fix redirects
---
astro.config.mjs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/astro.config.mjs b/astro.config.mjs
index b537afad..faeeaed7 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -182,7 +182,7 @@ export default defineConfig({
'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',
+ 'guides/release/android': 'guides/submitting/play-store',
+ 'guides/release/ios': 'guides/submitting/app-store',
},
});
From ca6a728be88d7c9b24839236b114f4c980c4ce6d Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Thu, 8 Aug 2024 17:37:22 -0400
Subject: [PATCH 5/5] Update astro.config.mjs
Co-authored-by: Felix Angelov <felix@shorebird.dev>
---
astro.config.mjs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/astro.config.mjs b/astro.config.mjs
index faeeaed7..8f503751 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -90,7 +90,7 @@ export default defineConfig({
},
},
{
- label: 'Submitting to the Stores',
+ label: 'Submitting to Stores',
autogenerate: {
directory: 'guides/submitting',
},