Microsite for Typelevel Scala fork

[juanpedromoreno]

This PR brings a microsite for the Typelevel for of the Scala Compiler. It's made thanks to the https://github.com/47deg/sbt-microsites plugin and the resources provided in this PR.

It takes as main documentation the README file from https://github.com/typelevel/scala. We've set up the initial URL at http://typelevel.org/scala but it could be changed at your convenience.

If you want to test locally you need Jekyll locally, depending on your platform, you might do this with:

yum install jekyll

apt-get install jekyll

gem install jekyll

Once you have installed it, you could perform the following steps:

• Build the microsite:

sbt "makeMicrosite"

• Then, to visualize the website in your browser, in a shell, navigate to the generated site directory in target/site
• Start jekyll with jekyll serve
• Navigate to http://localhost:4000

Please, review at your convenience. Many thanks!

Join-effort from the 47Deg team :)

[juanpedromoreno]

This is the proposal:

[milessabin]

This is great stuff ... thanks!

Can you say how this works in conjunction with typelevel.org?

[juanpedromoreno]

From the top of my head, nothing has changed from the previous version,
since all paths are the same, i.e. on the same segment cats. If I'm not
missing anything, the site it'd prepared to be deployed on
typelevel.org/cats.

Does it make sense?

On Sun, Sep 11, 2016, 4:15 PM Miles Sabin [email protected] wrote:

This is great stuff ... thanks!

Can you say how this works in conjunction with typelevel.org?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#117 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AEp0Df2_qQVYi2pH5Mch2bfO0oCkblUdks5qpA0GgaJpZM4J5w7K
.

[milessabin]

The org.typelevel site is a completely separate repo from this one, with it's own Jekyll build process ... I can merge this PR, but what mechanism are you proposing for including this content under org.typelevel?

[juanpedromoreno]

I got confused this thread with the other one opened at typelevel/cats#1369, sorry about that!.

I'm not completely sure how typelevel.github.com works, but maybe we could push this microsite to gh-pages branch within https://github.com/typelevel/scala and distribute the site in the same way as cats, for instance, under http://typelevel.org/scala.

In that case, we could change the permanent link here: https://github.com/typelevel/typelevel.github.com/blob/master/_projects/scala.md

Does it make sense?

[juanpedromoreno]

@larsrh @milessabin This is ready to go if looks good to you. Please, take a look at the documentation to see deeper info about how to publish it (https://47deg.github.io/sbt-microsites/docs/build-the-microsite.html). Thanks!

[larsrh]

Thanks @juanpedromoreno! I'll merge and publish this by hand for now (so that we can get it out for people to see). I'll try to find some time to automate publishing.

[larsrh]

@juanpedromoreno For some reason, the generated HTML looks off: the multi-line code snippets don't get properly formatted. Could you take a look please?

[juanpedromoreno]

Potentially, it could be because of an old Ruby/Jekyll version. Please,
could you check it and trying again with "sbt publishMicrosite"? Thanks.

On Sat, Sep 24, 2016, 11:43 PM Lars Hupel [email protected] wrote:

@juanpedromoreno https://github.com/juanpedromoreno For some reason,
the generated HTML looks off: the multi-line code snippets don't get
properly formatted. Could you take a look please?

[image: screenshot_20160924_234304]
https://cloud.githubusercontent.com/assets/923079/18811477/ac043b94-82b0-11e6-92a3-ca36f37777e1.png

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#117 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AEp0DWGb_5HM5Ye3LD4Fj3lbtW1Mlu9aks5qtZmagaJpZM4J5w7K
.

[larsrh]

I did sbt publishMicrosite. I thought I had a recent version of Jekyll installed (3.0.2), but after I've updated to (3.2.1), it's rendering correctly. Thanks!

[dwijnand]

You might want to consider setting up Bundler in the repo, instead of relying on whatever you have installed system-wide.

Here's how I did it for the ENSIME website: https://github.com/ensime/ensime.github.io/pull/24. (note some of that initial config later changed).

[milessabin]

Looks good.

What's the mechanism for updating the site when the README changes?

[juanpedromoreno]

Looks great @dwijnand

For the sbt-microsites docs, as another alternative, we are doing auto-publish each time we merge something in master branch.

https://github.com/47deg/sbt-microsites/blob/master/.travis.yml
https://github.com/47deg/sbt-microsites/blob/master/scripts/publishMicrosite.sh

[larsrh]

@milessabin No mechanism just yet. I'll try to get the automation set up next week.

[juanpedromoreno]

In the alternative that we've implemented, we just need to generate an ssh-key, adding it to this Github account (https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/). Then, Travis and the script commented before would do the rest of the work.

[larsrh]

@juanpedromoreno Yeah, I just resurrected our bot account, so this is precisely what we're going to do 😄