-
-
Notifications
You must be signed in to change notification settings - Fork 172
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
add bundler installation and comprehensive setup instructions #276
add bundler installation and comprehensive setup instructions #276
Conversation
Thank you @fmichonneau for putting together this first draft. I have a Mac, and would be happy to help write up instructions for Mac. Maybe we can work through this process together at our next meeting and you can help me troubleshoot? I know that @hoytpr has volunteered to test the Windows instructions as well. Practically - what's the best way for us to add to these instructions? Should we hold off on merging and have folks add their modifications / suggestions as commits directly to this PR? |
Just FYI, after some testing today there may need to be a baseline setting, i.e. uninstall any other Ruby versions, before installing anything. Testing Gitbash and WSL (& more). |
I have a new installation of Linux Mint 19.2 Cinnamon. I followed the instructions, but they didn't work. Details below:
No problem, I added it to my path and continued:
Troubleshooting:
|
The WINDOWS instructions have not worked for me. Not wanting to write and just say "I'm stuck", here's a summary of issues with a link to a Google Doc that Windows users should consider prior to attempting an install of Ruby, or bundle/Jekyll. NOTE: I have not tried a third-party installer (but yes there are some items installed now that look like third-party Ruby-items like nokogirl) I put much of this in a Google document, but it is basically in markdown format if we want to move it here. Notably, I've managed to break my working gitbash rendering in this process on multiple computers. But was able to restore one Gitbash using a process that is not well documented except for what is shown below. As a non-expert, it looks like a new version of Ruby is at least partially responsible. Here's the link to the Google doc: https://docs.google.com/document/d/1xtCFALO9ujqBKOGs9sDRtpVBVivTC1OEFzJeTh5mmj8/edit?usp=sharing I also have lots of results from using the WSL and installing a Windows Ubuntu 18.04 LTS "app". This is the current iteration of the WSL unless I'm misunderstanding. I tried to get this working and seemed to get very close, but in the end was not able to get this Ubuntu app to render the websites, despite having things setup in a way that appeared correct (see below). I've been working on this for at least a week, and took copious notes. If anyone has a question about my efforts just ask. As of Wednesday Oct 9, my Gitbash rendering failed with:
Running
THEN when I run:
Adding
Gitbash rendering ALSO fails using only "jekyll serve":
The Ubuntu 18.04 install fails giving a similar error as above, but the error I cannot resolve is
Trying "jekyll serve" also fails:
|
I have updated the Google doc significantly. Thanks @fmichonneau @ErinBecker @gcapes |
Thanks for the idea of starting a GDoc @hoytpr. I've started another GDoc for Mac install instructions that I'm working on here: https://docs.google.com/document/d/1Nvs-wx2yzi7O5wLyP8o35o5OZSHGN9VsubWvs0fO0mQ/edit (I've made it anyone with link can edit in case others want to contribute). I'll add another update here once I've gotten things working on my system. |
Hi @gcapes thanks for reporting your experience. The good news is that your bundler installation is successful. You happened to have uncovered an issue in the shell lesson which has been fixed in the newer version of the lesson template. I'm preparing a pull request to update to the latest version. Once it's merged you should be able to preview the lesson locally. EDIT: see swcarpentry/shell-novice#1051 for the pull request on the shell lesson. |
@hoytpr thanks for testing the installation instructions, and sorry for the frustrating process. Getting this to work properly is definitely a pain. From the information you provide, it looks like you managed to get to have bundler installed correctly on your Windows. Seeing the error message about having missing credentials to use the GitHub API is usually another issue and if the rendering goes this far, it means that the installation of bundler is working. Which lesson were you testing it on? I'd be happy to help you troubleshoot the error message about wdm but it's another issue which shouldn't impact your ability to preview the lesson. The error you get on your Ubuntu installation suggests that you're missing
in the |
setup.md
Outdated
|
||
#### Option 1 - Using the Windows Subsystem for Linux (WSL) | ||
|
||
If your version of Windows supports it, using the WSL will make the installation of the tools needed easier. Instructions to install Linux distributions from Windows 10/Windows Server are available from the [Microsoft website](https://docs.microsoft.com/en-us/windows/wsl/about). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to suggest to move all links to the bottom.
[Microsoft website][microsoft-website]
...
[microsoft-website]: https://docs.microsoft.com/en-us/windows/wsl/about
Hi @fmichonneau I was testing mostly on my own repo, derived from the DC-semester course. I hope to have a chance to go through the testing again very soon, on a different Win10 system, and will test on the organization-genomics repo using my new knowledge. Will give more concise feedback. |
FYI @fmichonneau on my Win10 machine with bundler installed, my local repo of Organization-genomics was a few commits behind. After fetching the updates (everything clean and up to date):
(bundler install testing still to come) |
This issue has some relevant install info for macOS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested the linux instructions after removing all components and it worked.
I do think that for a novice the instructions around what happens for make serve
is vague, so details would improve accessiblity
@fmichonneau @ErinBecker @gcapes @brownsarahm The bottom line: Do EVERYTHING (all of the installs) using the Windows cmd.exe terminal window run as administrator. When completed using ONE PROBLEM: A folder named Hoping this is helpful. |
I think you did the right thing. |
I got lesson previewing to work on my Mac (Mohave 10.14.6) using the Anaconda (conda-forge) versions of ruby and Jekyll. I tried to attach a YAML file of the environment, but GitHub doesn't support that file type. Instead, it is copied below.
clang* was required for the commonmarkers and eventmachine gems to compile. I've also got Xcode 10.3 (and the command line tools) installed, but I sorta lost track of if those were needed or not with the conda install. |
Thank you all for testing and reviewing these new instructions. I'm going to merge this for now but please continue to provide suggestions to improve these instructions as installing these tools remains a barrier of entry for people to contribute to our lessons. |
Following carpentries/maintainer-RFCs#1, here is a first draft of the updated setup instructions for Maintainers and community members to be able to render the lessons locally using Bundler.
These are far from being done and we'd love feedback from Maintainers to make them better and accurate.
The Windows installation instructions need to be better tested, especially by people who are not set up yet and need to go through the instructions and by people with more technical knowledge about Windows than I do to double-check that the instructions are comprehensive and accurate.
The macOS installation instructions need to be fully written. Unfortunately, I don't have this system at my disposal which makes writing installation instructions challenging.
Any other general content for clarity and comprehensiveness are welcome!
TODO