[Docs] Rename tutorials again

One of them being called getting-started will ensure these old URLs still work natively (it was the main link on the landing page).
input-output-hk · May 6, 2024 · aa5d71d · aa5d71d
1 parent 7214115
commit aa5d71d
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 16 deletions.
diff --git a/.github/workflows/check-tutorial.yaml b/.github/workflows/check-tutorial.yaml
@@ -29,7 +29,7 @@ jobs:
       shell: python
       run: |
         import re
-        with open("docs/docs/tutorial-testnet.md", "r") as tutorial:
+        with open("docs/docs/tutorial.md", "r") as tutorial:
             body = tutorial.read()
             usedCardanoNodeVersions = re.findall(r"cardano-node-([0-9]+\.[0-9]+\.[0-9]+)-.*\.tar\.gz", body)
 
@@ -50,7 +50,7 @@ jobs:
       shell: python
       run: |
         import re
-        with open("docs/docs/tutorial-testnet.md", "r") as tutorial:
+        with open("docs/docs/tutorial.md", "r") as tutorial:
             body = tutorial.read()
             usedMithrilEndpoints = re.findall(r"AGGREGATOR_ENDPOINT=(.*)", body)
 

diff --git a/docs/docs/tutorial-devnet-without-docker.md → docs/docs/getting-started-without-docker.md b/docs/docs/tutorial-devnet-without-docker.md → docs/docs/getting-started-without-docker.md
@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-# Quickstart without Docker
+# Getting started without Docker
 
 ```mdx-code-block
 import Tabs from '@theme/Tabs';

diff --git a/docs/docs/tutorial-devnet.md → docs/docs/getting-started.md b/docs/docs/tutorial-devnet.md → docs/docs/getting-started.md
@@ -1,14 +1,14 @@
-# Quickstart using a devnet
+# Getting started
 
 To get started quickly, let's walk you through our standard demo setup consisting of 
 
 - a cluster of three `hydra-node`, directly connected to each other, each having access to one of three Hydra credentials `alice`, `bob`, or `carol`;
 - a single `cardano-node` producing blocks used as a (very fast) local `devnet`;
 - the `hydra-tui` example clients to interact with the individual Hydra nodes.
 
-This tutorial will be using [Docker](https://www.docker.com/get-started) to install and the nodes, so make sure to have it installed. If you want to explore alternative ways of running the tools, see this [devnet tutorial](./tutorial-devnet-without-docker.md) variant or the [testnet tutorial](./tutorial-testnet.md) does use pre-built binaries, while documentation pages on [installation](../installation) and [configuration](../configuration) provide more details.
+This tutorial will be using [Docker](https://www.docker.com/get-started) to install and the nodes, so make sure to have it installed. If you want to explore alternative ways of running the tools, see this [tutorial variant](./getting-started-without-docker.md) or the [testnet tutorial](./tutorial.md) does use pre-built binaries, while documentation pages on [installation](./installation) and [configuration](./configuration) provide more details.
 
-Also, the `hydra-tui` does use the HTTP/WebSocket API provided by the `hydra-node` behind the scenes. The [testnet tutorial](./tutorial-testnet.md) will show how to use this API using low-level commands or see the [API reference](/api-reference).
+Also, the `hydra-tui` does use the HTTP/WebSocket API provided by the `hydra-node` behind the scenes. The [testnet tutorial](./tutorial.md) will show how to use this API using low-level commands or see the [API reference](/api-reference).
 
 <details>
 <summary>Video demonstration (a bit dated)</summary>
@@ -21,7 +21,7 @@ Also, the `hydra-tui` does use the HTTP/WebSocket API provided by the `hydra-nod
 These instructions have been tested only on Linux environments (Ubuntu, NixOS). If you're on Windows or Mac OS X, you might need to adapt to use [Volumes](https://docs.docker.com/storage/volumes/).
 :::
 
-## Getting started
+## Preparation
 
 All commands below are written as if executed from the `demo` folder in the project repository, so make sure to clone the repository, switch into the demo folder and pull the latest docker images:
 

diff --git a/docs/docs/getting-started/_category_.json b/docs/docs/getting-started/_category_.json
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -30,7 +30,7 @@ implied terms are excluded to the fullest extent permitted by law. For details,
 see also sections 7, 8 and 9 of the [Apache 2.0 License][license].
 :::
 
-Now, without further ado, read more about the protocol [on the next page](./protocol-overview.md) or jump right in to [getting started using a local devnet](./tutorial-devnet.md).
+Now, without further ado, read more about the protocol [on the next page](./protocol-overview) or jump right in to [getting started using a local devnet](./getting-started).
 
 [known-issues]: ./known-issues.md
 [license]: https://github.com/input-output-hk/hydra/blob/master/LICENSE
diff --git a/docs/docs/tutorial-testnet.md → docs/docs/tutorial.md b/docs/docs/tutorial-testnet.md → docs/docs/tutorial.md
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -19,12 +19,12 @@ module.exports = {
     },
     {
       type: "doc",
-      id: "tutorial-devnet",
-      label: "Quickstart using a devnet",
+      id: "getting-started",
+      label: "Getting started",
     },
     {
       type: "doc",
-      id: "tutorial-testnet",
+      id: "tutorial",
       label: "Open a head on testnet",
     },
     {

diff --git a/release.sh b/release.sh
@@ -179,7 +179,7 @@ update_api_version() {
 
 update_tutorial_version() {
   local version="$1"
-  local tutorial_file=docs/docs/tutorial-testnet.md
+  local tutorial_file=docs/docs/tutorial.md
   sed -i"" -e "s,\(version=\).*,\1$version," $tutorial_file
 }