docs(stackablectl): simplify install steps#315
Merged
Conversation
Member
Author
|
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] |
fhennig
approved these changes
Aug 14, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
&&(when only one needs to be run).chmodsteps with theinstall. @fhennig I can revert that if you want to keep the instructions the same as they were.I won't fix the windows install instructions, eg:
cpvscopy,/usr/local/binvs%USERPROFILE%\bin)%USERPROFILE%\binto the user'sPATHvariable? And restarting the shell, or logging out and in again?Definition of Done Checklist