Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(stackablectl): simplify install steps #315

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

NickLarsenNZ
Copy link
Member

@NickLarsenNZ NickLarsenNZ commented Aug 14, 2024

Description

  • Split install commands so that the copy button doesn't join them with && (when only one needs to be run).
  • Replace the chmod steps with the install. @fhennig I can revert that if you want to keep the instructions the same as they were.
  • Windows: add a step to test the command
    I won't fix the windows install instructions, eg:
    • Do we assume CMD, PowerShell, or WSL2? (cp vs copy, /usr/local/bin vs %USERPROFILE%\bin)
    • Adding %USERPROFILE%\bin to the user's PATH variable? And restarting the shell, or logging out and in again?

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Reviewer

Preview Give feedback

@NickLarsenNZ NickLarsenNZ requested a review from fhennig August 14, 2024 10:41
@NickLarsenNZ NickLarsenNZ self-assigned this Aug 14, 2024
@NickLarsenNZ
Copy link
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]

@NickLarsenNZ NickLarsenNZ enabled auto-merge August 14, 2024 10:46
@NickLarsenNZ NickLarsenNZ added this pull request to the merge queue Aug 14, 2024
Merged via the queue into main with commit 18de1a4 Aug 14, 2024
37 checks passed
@NickLarsenNZ NickLarsenNZ deleted the docs/stackablectl-installation branch August 14, 2024 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants