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
CLI Installation Guide #2535
Comments
+1 for all of the above. |
It's times like these where I wish I knew more about frontend. I wonder how this would look... like an interactive slideshow? Not sure. A mockup could be fun to make. |
I keep hoping someone with frontend skills will be super-inspired to work on this. If not I'll have to finally go learn some proper design, HTML, CSS, and enough JavaScript to make it so. |
Ref: #2711 |
Katrina, The short version has doable actions in 1) + 2), but needs the full set of instructions for 3) which aren't obvious until scrolling down - it's easy enough to download + extract, but the path part is confusing. so, instead, we're suggesting that the short version should be without links, and could be titled something like: 3 steps you'll be taking to download Exercism. and then |
Hi @kytrinyx Re:Detect your operating system (linux, windows, mac), or if unable to detect, let you choose. Please clarify!
|
On the Mac OSX page "methods of installing CLI" I get:
should be grouped together on the one page, and when you're done, there's copy such as: |
Yeah, I think that's a good idea.
We should be able to figure out if they are on linux, windows, or mac, and automatically select the correct tab or page for them. They would still be able to switch to a different page/tab (however we end up doing it). If we don't know what system they are on, we should have a default view that directs them to click on the correct link for their system (windows, mac, or linux).
Yes, once they are on the correct tab or page for the operating system, we will still need to help them figure out if they have a 32-bit or 64-bit machine (for mac and windows). For Linux it might be 32-bit or 64-bit, but it might also be a raspberry pi, which means one of the ARM downloads.
It's slightly more complicated than that... there are always things to choose from, so it won't be just one link. But I would like to provide links to download the relevant binaries; we need to provide more than one link, and as mentioned above, help them figure out which they need).
Yeah, I think that we should walk you through step-by-step, and not confuse you with any other potential workflows. If you're doing the homebrew thing, then we shouldn't refer to any of the other installation methods as part of the workflow. We should probably have small print that lets them choose a different installation method, but that's a separate problem :) |
@kytrinyx @troubalex |
A couple of comments/questions:
I cannot comment so much on the copy itself, but I suggest you use public gists which you can link to from here. There you can use markdown for structure and formatting which will make it easy to transfer the content afterwards. A more detailed discussion can then happen in the context of each gist. |
thankyou - that's the aim.
I wanted to make downloading the CLI cleaner and simpler, and felt that nav at the top helped with that.
Where you've recommended in your comments in the thread - into a troubleshooting page. I plan to have links to the troubleshooting page along with gitter at the top (and bottom?) of each install page.
I'm not quite sure what you mean... in that the instructions are in dedicated pages visually now. Will bring that up with you off github. What I have done is a quick drawing of a potential flow of info:
Agreed, and that CSS is tricky - I'll write up a separate issue about it, as I'm concerned about where else the margin issue is, and the ramifications (eg maybe it's like that for a reason for viewing code in the dashboard? I don't know. There's other pages using that code such as help, so it would be good to know how large a project that is before getting started.
thanks - taken on board, and will provide when done. |
I don't think it's possible to avoid horizontal scrolling in all cases, and that's okay. The tabs in the sidebar break onto the top on smaller screens, thanks to Bootstrap's responsive grid, so that's not an issue either. Consistency however is. 👍
That makes sense to me. |
@troubalex - here's the gists for each section: I really need to get these working locally, as I'm finding it difficult to work out what's missing etc in gist/markdown form, and it would be great to have the website locally to work through. What are your thoughts? Let's talk offline and work out next steps. |
The structure looks good to me. I can't really comment on the content though, we'll have to make sure to get an extra round of proofreading once this is ready for a PR. As you suggested, I'd move on to making the actual pages, and then we take it from there. |
There's the open pull request: #3089 [] Detect Operating System and redirect to appropriate OS as discussed in issue 2535 |
In the future, would you please put the screenshots in the pull request, not in the original issue? I didn't see this until after I had reviewed the pull request. The general rule of thumb for pull requests is to put everything that the reviewers would need right there—link to other places for more information, but people shouldn't have to follow the links to get the most important bits. Side note: checklists in markdown are made like this:
|
Related: #3332 |
The CLI documentation has been massively improved since I originally posted this. I'm going to go ahead and close this, and we can revisit the idea if it becomes clear that it would be a big improvement. |
This issue is a UX, design, and front-end task
Right now getting the command-line client installed is incredibly confusing, and the documentation and troubleshooting guides are all over the place.
It would be absolutely lovely if we could have a "CLI installation guide" that would guide you through each step of installing and configuring the binary.
The suggestions below are just that--a starting point based on the current user interviews and support requests that come in.
We would probably want to embed the guide into a section of the dashboard, and then when you've submitted a solution, tuck it away to somewhere findable/accessible, but no longer the main focus (since someone might want to set up a separate computer and might need to follow the guide again for a different platform).
The text was updated successfully, but these errors were encountered: