Change quickstart doc piece installation script to use the 'quick sta…

…rt' script. (#2311) * Change quickstart installation script to use the 'quick start' script. * remove admonition --------- Co-authored-by: Roman Dodin <[email protected]>
srl-labs · Nov 25, 2024 · 0ab40c3 · 0ab40c3
1 parent f835531
commit 0ab40c3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -30,14 +30,14 @@ The script officially supports the following OSes:
 * Rocky Linux 9.3, 8.8 (should work on any 9.x and 8.x release)
 
 To install all components at once, run the following command on any of the supported OSes:
-
+<!-- --8<-- [start:quick-setup-script-cmd] -->
 ```bash
 curl -sL https://containerlab.dev/setup | sudo -E bash -s "all"
 ```
 
-/// note
-To complete installation please execute `newgrp docker` or logout and log back in.
-///
+Complete installation and enable sudo-less `docker` command execution please run `newgrp docker` or logout and log back in.
+
+<!-- --8<-- [end:quick-setup-script-cmd] -->
 
 To install an individual component, specify the function name as an argument to the script. For example, to install only `docker`:
 
@@ -139,7 +139,6 @@ sudo dnf install containerlab
 
 ////
 
-
 //// tab | DNF5
 
 ```bash

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -6,9 +6,9 @@ hide:
 
 ## Installation
 
-Getting containerlab is as easy as it gets. Thanks to the trivial [installation](install.md) procedure it can be set up in a matter of a few seconds on any RHEL or Debian based OS[^1].
+Getting containerlab is as easy as it gets. Thanks to the [quick setup script](install.md#quick-setup) you can get up and running in a matter of seconds on any RHEL or Debian based OS[^1].
 
---8<-- "docs/install.md:install-script-cmd"
+--8<-- "docs/install.md:quick-setup-script-cmd"
 
 ## Topology definition file
 
@@ -124,7 +124,7 @@ sudo containerlab deploy # (1)!
   If you have several files and want to pick a specific one, use `--topo <path>` flag.
 
 In no time you will see the summary table with the deployed lab nodes.  
-The table will show the node name (which equals to container name), node kind, image name and a bunch of other usefule information. You can always list the nodes of the lab with [`containerlab inspect`](cmd/inspect.md) command.
+The table will show the node name (which equals to container name), node kind, image name and a bunch of other useful information. You can always list the nodes of the lab with [`containerlab inspect`](cmd/inspect.md) command.
 
 ```
 +---+---------------------+--------------+-----------------------+---------------+---------+-----------------+----------------------+