stackabletech / stackable-cockpit

Home of stackable-cockpit, stackablectl and stackable-cockpitd
https://docs.stackable.tech/management/stable/
Other
7 stars 2 forks source link

docs(stackablectl): simplify install steps #315

Closed NickLarsenNZ closed 1 month ago

NickLarsenNZ commented 1 month ago

Description

Definition of Done Checklist

# Reviewer
- [ ] Documentation added or updated
NickLarsenNZ commented 1 month ago

Here is a diff for the in-progress Windows instructions:

diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc
index 7c55400..5129fd8 100644
--- a/docs/modules/stackablectl/pages/installation.adoc
+++ b/docs/modules/stackablectl/pages/installation.adoc
@@ -124,9 +124,15 @@ access it from anywhere if you like:

 [source,console]
 ----
-$ cp target/release/stackablectl /usr/local/bin
+$ mkdir %USERPROFILE%\bin
+$ copy target\release\stackablectl %USERPROFILE%\bin
 ----

+[TIP]
+====
+Ensure `%USERPROFILE%\bin` is part of the user's PATH variable. You can do ...
+====
+
 Test that it works:

 [source,console]