Skip to content
This repository has been archived by the owner on Jan 3, 2018. It is now read-only.

README: add jekyll installation instruction for Debian #586

Closed
wants to merge 1 commit into from

Conversation

keszybz
Copy link
Contributor

@keszybz keszybz commented Jul 6, 2014

No description provided.

If you have Ruby installed on your computer,
this *should* be as simple as:

If you are using Debian or Ubuntu or a derivative, this is as simple as:
Copy link
Contributor

Choose a reason for hiding this comment

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

Since very few people are likely to be in this boat I suggest putting these instructions down after the ones for Mac.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On Sat, Jul 05, 2014 at 10:22:20PM -0700, Matt Davis wrote:

@@ -264,8 +264,15 @@ and the information about your bootcamp.

Note:
you will need to install Jekyll 1.0.3 or later in order to preview things locally.
-If you have Ruby installed on your computer,
-this should be as simple as:
+
+If you are using Debian or Ubuntu or a derivative, this is as simple as:

Since very few people are likely to be in this boat I suggest putting these instructions down after the ones for Mac.

After looking at the order again, I still think that this is the proper place:
above the generic instructions with 'gem install ...'. If someone is using a Mac,
they'll know that the instruction for Debian do not apply to them. If
someone is using a Linux distribution, installing using gem is possible but an
inferior option, so it's better if they use the distribution-provided packages
rather than follow generic installation instructions.

BTW., I have now pushed an updated commit which adds a few more packages (make,
pandoc, ...) to the list of packages to install. AFAICT, github silently substituted
the commit, and the pull request shows this updated commit with your comment,
but just to make sure: the new one is 38200fe.

@rgaiacs rgaiacs added the tools label Sep 27, 2014
@rgaiacs rgaiacs self-assigned this Sep 27, 2014
@rgaiacs
Copy link

rgaiacs commented Sep 27, 2014

@keszybz Thanks for your contribution. We probably will reword README.md and include this.

@gvwilson
Copy link
Contributor

@r-gaia-cs @jiffyclub good to merge?

If you are using Debian or Ubuntu or a derivative, this is as simple as:

~~~
apt-get install jekyll ruby-kramdown ruby-colored make python ipython-notebook unzip pandoc
Copy link

Choose a reason for hiding this comment

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

If I'm a R user maybe I don't want to install ipython-notebook. This line should only cover jekyll. Maybe

$ apt-get install jekyll ruby-kramdown

@jiffyclub
Copy link
Contributor

One thing to think about that doesn't necessarily need to be addressed by this PR: for workshop setup instructions we break things down in detail across different system types and the things to install. For these instructions we're kind of throwing everything together with little organization. I think we might want to revisit this after #759 and organize the site build instructions by system and tool as we do for workshops.

@keszybz
Copy link
Contributor Author

keszybz commented Sep 29, 2014

If I'm a R user maybe I don't want to install ipython-notebook. This line should only cover jekyll.
The cost of installing a few additional (binary) packages is essentially zero. The time to read the instructions is worth more than the tiny amount of disk space. So I think that the "big hammer" approach of installing everything at once is right in this case.

@jiffyclub
Copy link
Contributor

I strongly disagree. These instructions are specifically about how to build a workshop site. Python and the Notebook are unnecessary for that. Having extra, unrelated installs listed here only confuses things.

@rgaiacs
Copy link

rgaiacs commented Sep 29, 2014

@jiffyclub Yes, the README.md will need to be rewrite after #759. I want to merge it just as a reminder when we going to rewrite README.md but I'm OK to don't merge it if it is blocking #759. @gvwilson Any comment?

@keszybz Normally I will agree with you in

The cost of installing a few additional (binary) packages is essentially zero. The time to read the instructions is worth more than the tiny amount of disk space. So I think that the "big hammer" approach of installing everything at once is right in this case.

I disagree on this because to preview the lessons the user only need Jekyll. If the user is going to modify the Python lesson he/she will need IPython Notebook but if the user is going to modify the R lesson he/she will need R/RStudio, so why not

$ apt-get install r rstudio jekyll ruby-kramdown ruby-colored make python ipython-notebook unzip pandoc

@rgaiacs
Copy link

rgaiacs commented Sep 30, 2014

I will close this for now and work on it after we explode the repo.

@rgaiacs rgaiacs closed this Sep 30, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants