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

update getting started #689

Merged
merged 7 commits into from
Aug 22, 2023
Merged

update getting started #689

merged 7 commits into from
Aug 22, 2023

Conversation

CaroMac
Copy link
Contributor

@CaroMac CaroMac commented Aug 10, 2023

update Getting Started button on Landing page to point to Intro and Architecture
add info about which MacOS download to choose for the cli tool
add info about potential error messages when renaming
add info about PATH

@CaroMac
Copy link
Contributor Author

CaroMac commented Aug 10, 2023

Copy link

@matcomer matcomer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firstly thank you for making these changes.

I am happy with the first one (for providing guidance on which download is applicable depending on the type of Mac)
My one comment on this (as briefly discussed with you Caroline), for many Mac users, it may be obvious which download is required (even though it wasn't obvious to me). Perhaps the statement can be indented or given a sub heading and put on a separate line so it has less emphasis?

For the second change (concerning the path and access), thank you for the update. Its great to have the some more content on this. I think this one is more complex and so needs a little more thought.

a) similar to comment above, I would suggest separating this extra help from the required step (so as not to confuse those who are more familiar with Macs/ command lines and this is a no brainer for them). i.e. keep "After downloading the binary, re-name it to galasactl." as-is - then have the new wording as a separate sub-section that optionally provides more guidance for those who need more help.
b) I would change the ordering. I did the PATH and chmod steps first. It wasn't till after these that I hit the '...cannot be opened because it is from an unidentified developer' issue
c) the following new text "... click OK, go to Privacy & Security in your System Settings, and click Open Anyway. Alternatively, control-click the downloaded icon, choose Open from the pop-up menu and then click Open." is not quite right
i) I had to go to Privacy & Security in your System Settings
ii) I had to select 'Developer tools'
iii) I had to add 'galasactl' using the plus icon
iv) important piece here: running from a CLI still would not work at this point. I had to run Galasa from Finder. To do this 'Right click galasctl in Developer tools' and 'select Show in Finder'. Then 'double click on galasactl in Finder'. This then presents a surety warning that has to be accepted (I can no longer reproduce now mine is setup, so can't recall the exact wording'. Only then galasactl would work
v) Once galasactl had worked successfully through Finder, I was then able to run through a terminal/ CLI

My recommendation would be to find someone with a Mac who hasn't used Galasa before and try walk through these steps for yourself. I appreciate this is a pain, may take some time but would help you see for yourself

@techcobweb
Copy link
Contributor

techcobweb commented Aug 18, 2023

If you are on a mac, you can use uname -m to get the machine architecture. Values will be arm64 or amd64, and you can use that to guide you on which file to download.

@techcobweb
Copy link
Contributor

See #700 for an extra step on the command-line which allows the galasactl executable to be executed.

Copy link
Contributor

@techcobweb techcobweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the https://github.com/galasa-dev/projectmanagement/issues/1551 detail, and the uname -m detail ?

@CaroMac
Copy link
Contributor Author

CaroMac commented Aug 21, 2023

Hi @matcomer , thank you for the review and the comments. I have an M1 Mac and I did try out the steps I documented on my machine and it worked for me. I always do this where possible to make sure the instructions are correct. I also tried out the Windows instructions on a Windows machine. I think you might not have an M1 (based on the download you needed), so I guess that there are some differences in the menu options etc. I think the cleanest way forward is therefore to just use uname -m (as @techcobweb mentioned) to get the machine architecture, and that removes the complexity of differences between models menu options. The development of #700 should also make things easier as it will allow the galasactl executable to be executed without having to do the various other steps that seem to be slightly different depending on what Mac you have. I like the idea of the indenting / separating the extra help so will incorporate that formatting in the update.

@CaroMac
Copy link
Contributor Author

CaroMac commented Aug 21, 2023

If you are on a mac, you can use uname -m to get the machine architecture. Values will be arm64 or amd64, and you can use that to guide you on which file to download.

@techcobweb I chatted with Mat before I went on holiday and his system returned 'x86_64' when he typed uname -m. Mine returns arm64.

@CaroMac CaroMac requested a review from matcomer August 22, 2023 12:22
@matcomer
Copy link

This looks much clearer - thank you.
Approving

@CaroMac CaroMac merged commit d6332ae into galasa-dev:main Aug 22, 2023
10 checks passed
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.

3 participants