feat: use branch name instead of tag for stable docs (#32614)

* feat: use branch name instead of tag for stable docs Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * test Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * paginate everything Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * different return value Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * update both flows Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * add docs Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> * Change checkout ref from tags to heads Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com> --------- Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com> Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
2026-03-12 11:03:13 -04:00
parent a9d338d1a3
commit 269b85ef0d
3 changed files with 26 additions and 19 deletions
@@ -13,6 +13,7 @@ This website was created with [Docusaurus](https://docusaurus.io/).
 - [Editing Content](#editing-content)
 - [Adding Content](#adding-content)
 - [Full Documentation](#full-documentation)
+- [How to patch the stable docs](#patching-the-docs)

 # Getting Started

@@ -240,3 +241,7 @@ Full documentation can be found on the [Docusaurus website](https://docusaurus.i
 A feedback widget is provided by the `docusaurus-pushfeedback` plugin, which connects to the https://pushfeedback.com service. Styling of the button is configured in `microsite/src/theme/customTheme.scss`, while the plugin itself is configured in `microsite/docusaurus.config.js`.

 Feedback submissions are connected to an account owned by @Rugvip and are available on request, reach out to @Rugvip on [Discord](https://discord.gg/backstage-687207715902193673).
+
+# Patching the docs
+
+To patch the documentation for the stable version, you can submit a PR to the correct `patch/v<version>` branch. For example, if `1.48.0` is the stable version, you would submit a fix to the branch `patch/v1.48.0`. Once your fix is in, you can trigger the `deploy_microsite` GH action (or wait until the next run on master) and you should see the fix on the stable version at https://backstage.io/docs.