New Proposal for the Cats Microsite #1369

juanpedromoreno · 2016-09-11T10:50:40Z

This PR brings a new proposal for the Typelevel Cats website microsite.

It's made thanks to the https://github.com/47deg/sbt-microsites plugin and:

Provides the override.css file and the images resources.
Removes the versioned site.
Modifies the src/main/tut resources according to: root files, typeclasses and datatypes.
Updates the current documentation.
Other minor tweaks to be able to generate the site successfully.

The generated site has been removed since is not needed from now on. As you can see in the contributing.md file, the site can be generated each time on the fly.

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 docs/makeMicrosite

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

Please, review at your convenience. Thanks!

Join-effort from the 47Deg team :)

* Removes sbt-site and tut plugins since they are transitive dependencies from sbt-microsite plugin * Updates some configurations that are deprecated in the old 0.8 version of the sbt-site plugin. sbt-microsite plugin is using the 1.0.0 * Modifies all the documentation structure according to the new proposal

juanpedromoreno · 2016-09-11T11:02:48Z

kailuowang · 2016-09-11T11:56:13Z

Thanks very much!
Can you expand on "on the fly" a little bit more? What triggers generating the site and push it to gh-page branch? I could not find it on sbt-microsites doc.

juanpedromoreno · 2016-09-11T12:04:20Z

Sure, I guess site publication are disabled right now.

cats/scripts/travis-publish.sh

Line 22 in 449e0b0

# temporarily disable to stabilize travis

Therefore, in the meantime this publish should performed by hand in the same way until now (sbt ghpagesPushSite), but in this case from the docs/target/site path (that is generated on the fly when you run run makeMicrosite). Does it make sense?

https://github.com/typelevel/cats/blob/master/CONTRIBUTING.md#publishing-the-site-to-github

I'm sorry about the sbt-microsites plugin documentation, it's still a WIP (actively working on it), nevertheless we hope to have ready all the plugin docs by this week. At the same time, we are working to have gh-pages sbt plugin integrated as a part of the sbt-microsites plugin workflow (perhaps for the next snapshot version).

kailuowang · 2016-09-11T12:22:16Z

Ah that makes sense. Thanks! Is there a plan to release sbt-microsites? Looks very helpful.

juanpedromoreno · 2016-09-11T12:41:42Z

Yep, it'll be released very soon!

On Sun, Sep 11, 2016, 2:22 PM Kai(luo) Wang [email protected]
wrote:

Ah that makes sense. Thanks! Is there a plan to release sbt-microsites?
Looks very helpful.

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

ghost · 2016-09-11T16:43:44Z

@juanpedromoreno This looks very nice!!

One thing that the cats docs do not currently do/have is support for current/previous versions - eg
https://www.scala-js.org/doc/all-api.html and http://tpolecat.github.io/doobie-0.3.0/00-index.html

Had you thought about this as part of your new plugin?

juanpedromoreno · 2016-09-11T19:47:56Z

@BennyHill Not yet, but we'll do. Thanks!

ghost · 2016-09-11T21:18:59Z

@juanpedromoreno I know your plugin is still WIP, 0.1.0 etc - I just thought I should pipe in with something that was on a TODO list at some point, lest it be forgotten. Looks cools already, btw 😸

…esolver

codecov-io · 2016-09-12T14:31:06Z

Current coverage is 91.68% (diff: 100%)

Merging #1369 into master will not change coverage

@@             master      #1369   diff @@
==========================================
  Files           240        240          
  Lines          3608       3608          
  Methods        3540       3540          
  Messages          0          0          
  Branches         67         67          
==========================================
  Hits           3308       3308          
  Misses          300        300          
  Partials          0          0

Powered by Codecov. Last update 9f981b1...ed35844

kailuowang · 2016-09-12T14:36:18Z

LGTM, I am wondering if we should wait for sbt-microsites release before merging this one in.

juanpedromoreno · 2016-09-15T10:46:01Z

👍 We're working in the sbt-microsites release at this moment, we'll let you know once everything is ready. Thanks!

jhzab · 2016-09-15T17:57:29Z

Two small comments:

Is there some mechanism to include the current release version in the index.md file? I think automating this makes sense.
I was really surprised that I could actually build cats with the sbt default memory settings, but could not build the site with 1GB. (But that is also true for the current master.)

juanpedromoreno · 2016-09-16T20:59:15Z

@jhzab For comment 1, potentially, it could be accomplished with tut, but I have to give a try.

For point 2, yep, you're right, compiling tut documents could take some time and memory (couple of GB of Xmx should be enough).

kailuowang · 2016-09-23T13:00:52Z

@juanpedromoreno thanks again. It looks like sbt-microsites has been released. I wonder if you have time to update this PR? Otherwise I can pick it up.

juanpedromoreno · 2016-09-23T13:53:31Z

Sure @kailuowang . I'll do it this afternoon. Thanks!

juanpedromoreno · 2016-09-24T00:52:50Z

@kailuowang Done ;)

adelbertc · 2016-09-25T17:33:15Z

Looks like the 2.11 build was failing, not sure why, I've restarted it.

juanpedromoreno · 2016-09-25T18:14:18Z

It's green now, thanks @adelbertc

kailuowang · 2016-09-26T12:14:53Z

👍 thanks a lot!

ceedubs · 2016-09-26T13:26:19Z

Thanks a bunch, @juanpedromoreno! This looks really nice. I'm hoping I can find the time to take a closer look this evening or tomorrow.

juanpedromoreno · 2016-10-10T09:01:46Z

Hey @ceedubs @kailuowang, is there anything else I can do about this PR? Just let me know. Thanks!

kailuowang · 2016-10-17T22:09:55Z

@juanpedromoreno LGTM.

ceedubs · 2016-10-18T17:53:36Z

@juanpedromoreno I'm sorry for the long delay on this. Life has gotten busy. I won't get a chance to look at this in the next several days. It looks like @kailuowang already gave a 👍. @adelbertc or @tpolecat (or anyone else) would you want to review this?

juanpedromoreno · 2016-10-19T09:00:23Z

Sure, no problem @ceedubs

adelbertc · 2016-10-21T04:20:17Z

project/plugins.sbt

 addSbtPlugin("pl.project13.scala"   % "sbt-jmh"               % "0.2.11")
 addSbtPlugin("org.scalastyle"      %% "scalastyle-sbt-plugin" % "0.8.0")
 addSbtPlugin("org.scoverage"        % "sbt-scoverage"         % "1.2.0")
 addSbtPlugin("com.typesafe.sbt"     % "sbt-git"               % "0.8.5")
 addSbtPlugin("org.scala-js"         % "sbt-scalajs"           % "0.6.11")
 addSbtPlugin("com.github.tkawachi"  % "sbt-doctest"           % "0.4.1")
 addSbtPlugin("org.xerial.sbt"       % "sbt-sonatype"          %  "1.1")
+addSbtPlugin("com.fortysevendeg"    % "sbt-microsites"        % "0.2.4")


adelbertc · 2016-10-21T04:22:20Z

I have approximately negative web dev experience but I looked at the changes and looks OK to me? 👍 from me.

kailuowang · 2016-10-21T14:16:53Z

Thanks @adelbertc merging with two thumbs up.

adelbertc · 2016-10-21T16:29:31Z

@juanpedromoreno @kailuowang How do we get this published on typelevel.org/cats ?

juanpedromoreno · 2016-10-21T16:57:05Z

@adelbertc @kailuowang Any person with permission to push to gh-pages branch simply could do:

sbt docs/publishMicrosite

That's it ;)

kailuowang · 2016-10-21T16:59:26Z

I can give it a try, will ask in gitter room first.

kailuowang · 2016-10-21T17:47:45Z

Published! Many thanks again @juanpedromoreno

kailuowang · 2016-10-21T17:50:01Z

I noticed that it generates a new file docs/src/main/tut/contributing.md
shall we add that to git or gitignore?

juanpedromoreno · 2016-10-21T17:59:21Z

@kailuowang You can commit it or ignore it. It's copied (from the project root to the docs module) each time the microsite is built. The plugin needs to copy it for the tut compile phase (potentially contributing.md hasn't scala code, but the setting is generic for any kind of markdown file :/ ).

juanpedromoreno and others added 2 commits September 10, 2016 19:25

Resources + color palette

2909bb8

juanpedromoreno mentioned this pull request Sep 11, 2016

Microsite for Typelevel Scala fork typelevel/scala#117

Merged

Updates the contributing section and it adds the sonatype snapshots r…

b8301c4

…esolver

kailuowang mentioned this pull request Sep 15, 2016

Bump version number to 0.7.2 on the cats website #1376

Merged

Merge remote-tracking branch 'upstream/master'

ff81eba

juanpedromoreno added 2 commits September 24, 2016 02:22

Upgrades to the latest sbt-microsites release

669804c

Merge remote-tracking branch 'upstream/master'

87a72a6

longcao mentioned this pull request Oct 17, 2016

Doc fixups #1348

Closed

kailuowang mentioned this pull request Oct 17, 2016

Start using sbt-microsites for doc #1409

Closed

sritchie mentioned this pull request Oct 18, 2016

Generate Algebird microsite via sbt-microsites twitter/algebird#556

Merged

adelbertc reviewed Oct 21, 2016

View reviewed changes

juanpedromoreno added 2 commits October 21, 2016 13:23

Merge remote-tracking branch 'upstream/master'

9fbda12

Bumps sbt-microsites version

ed35844

kailuowang merged commit fe026bc into typelevel:master Oct 21, 2016

raulraja mentioned this pull request Oct 22, 2016

Support multiple project versions 47degrees/sbt-microsites#67

Closed

This was referenced Oct 23, 2016

small wording change to semigroup.md for clarity #1404

Closed

Bad markdown spacing was making subtitle to not render properly #1393

Closed

Adapt links to new site #1436

Closed

travisbrown mentioned this pull request Nov 6, 2016

Switch to sbt-microsites circe/circe#438

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Proposal for the Cats Microsite #1369

New Proposal for the Cats Microsite #1369

juanpedromoreno commented Sep 11, 2016 •

edited

Loading

juanpedromoreno commented Sep 11, 2016

kailuowang commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016 •

edited

Loading

kailuowang commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016

ghost commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016

ghost commented Sep 11, 2016

codecov-io commented Sep 12, 2016 •

edited

Loading

kailuowang commented Sep 12, 2016

juanpedromoreno commented Sep 15, 2016

jhzab commented Sep 15, 2016 •

edited

Loading

juanpedromoreno commented Sep 16, 2016

kailuowang commented Sep 23, 2016

juanpedromoreno commented Sep 23, 2016

juanpedromoreno commented Sep 24, 2016

adelbertc commented Sep 25, 2016

juanpedromoreno commented Sep 25, 2016 •

edited

Loading

kailuowang commented Sep 26, 2016

ceedubs commented Sep 26, 2016

juanpedromoreno commented Oct 10, 2016

kailuowang commented Oct 17, 2016

ceedubs commented Oct 18, 2016

juanpedromoreno commented Oct 19, 2016

adelbertc Oct 21, 2016

adelbertc commented Oct 21, 2016

kailuowang commented Oct 21, 2016

adelbertc commented Oct 21, 2016

juanpedromoreno commented Oct 21, 2016 •

edited

Loading

kailuowang commented Oct 21, 2016

kailuowang commented Oct 21, 2016

kailuowang commented Oct 21, 2016

juanpedromoreno commented Oct 21, 2016

New Proposal for the Cats Microsite #1369

New Proposal for the Cats Microsite #1369

Conversation

juanpedromoreno commented Sep 11, 2016 • edited Loading

juanpedromoreno commented Sep 11, 2016

kailuowang commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016 • edited Loading

kailuowang commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016

ghost commented Sep 11, 2016

juanpedromoreno commented Sep 11, 2016

ghost commented Sep 11, 2016

codecov-io commented Sep 12, 2016 • edited Loading

Current coverage is 91.68% (diff: 100%)

kailuowang commented Sep 12, 2016

juanpedromoreno commented Sep 15, 2016

jhzab commented Sep 15, 2016 • edited Loading

juanpedromoreno commented Sep 16, 2016

kailuowang commented Sep 23, 2016

juanpedromoreno commented Sep 23, 2016

juanpedromoreno commented Sep 24, 2016

adelbertc commented Sep 25, 2016

juanpedromoreno commented Sep 25, 2016 • edited Loading

kailuowang commented Sep 26, 2016

ceedubs commented Sep 26, 2016

juanpedromoreno commented Oct 10, 2016

kailuowang commented Oct 17, 2016

ceedubs commented Oct 18, 2016

juanpedromoreno commented Oct 19, 2016

adelbertc Oct 21, 2016

Choose a reason for hiding this comment

adelbertc commented Oct 21, 2016

kailuowang commented Oct 21, 2016

adelbertc commented Oct 21, 2016

juanpedromoreno commented Oct 21, 2016 • edited Loading

kailuowang commented Oct 21, 2016

kailuowang commented Oct 21, 2016

kailuowang commented Oct 21, 2016

juanpedromoreno commented Oct 21, 2016

juanpedromoreno commented Sep 11, 2016 •

edited

Loading

juanpedromoreno commented Sep 11, 2016 •

edited

Loading

codecov-io commented Sep 12, 2016 •

edited

Loading

jhzab commented Sep 15, 2016 •

edited

Loading

juanpedromoreno commented Sep 25, 2016 •

edited

Loading

juanpedromoreno commented Oct 21, 2016 •

edited

Loading