Prepare documentation using site in GitHub Pages #1189

mroderick · 2016-11-16T18:23:57Z

This is a PR for master, it implements a new documentation site using GitHub Pages (well Jekyll underneath).

This is the squashed version of my work-in-progress branch. I can't imagine anyone being interested in seeing all the detours I took to get here... if I am wrong, please speak up and I'll post a link to it.

I (now) think we can do everything that we need to with GitHub Pages, so there's really no reason to complicate things by having yet another system to manage.

There's still a lot of work left to do on the new documentation website, however I think we should merge this branch, as it will:

allow me to finish configuring GitHub Pages, so we can see that the site actually works there
allow others to contribute to finishing the documentation site

If this PR is merged, I will update #991 to track the remaining work. Specifically, I will (as a minimum) add these tasks.

I will try to convince the creator of the new favicon to create a better design and some illustrations for the site.

To verify

Check out this branch
cd docs
gem install bundler
bundle install
bundle exec jekyll serve
Navigate to http://localhost:4000/
Click around, and see if you can find any errors

coveralls · 2016-11-16T18:25:24Z

Coverage remained the same at 96.319% when pulling 7b522c9 on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

coveralls · 2016-11-16T21:16:20Z

Coverage remained the same at 96.319% when pulling d3124b5 on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

coveralls · 2016-11-17T10:35:24Z

Coverage remained the same at 96.319% when pulling a87f59f on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

coveralls · 2016-11-17T10:35:24Z

Coverage remained the same at 96.319% when pulling a87f59f on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

coveralls · 2016-11-17T11:23:27Z

Coverage remained the same at 96.319% when pulling 896d140 on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

fatso83

This is a tremendous amount of great work, Morgan! Fantastic! This makes a 2.0 release feel a lot closer (finally) :-D

Just a few typos I saw when glancing over the changes.

fatso83 · 2016-11-17T13:19:43Z

RELEASE.md


-Compile interesting highlights from [`git changelog`](https://github.com/tj/git-extras/blob/master/Commands.md#git-changelog) into Changelog.md
+1. `npm version [keyword]`
+    - Updates `Changlelog.txt` - you will need to edit this


I think that was fixed in a later commit, I can't find it in the source

Bah, looking in the wrong project ..

fatso83 · 2016-11-17T13:20:58Z

docs/CONTIBUTING.md

@@ -0,0 +1,41 @@
+# Contribruting to documentation


typo. also the name of the file is missing an r.

mantoni · 2016-11-17T14:58:23Z

Just played around with the website a little. Looks really good. I like it 👍

The only thing that I found are some funny quotes in APIs. I guess that is macOS being clever about quotations. Especially the matchers page has some and in the spy and stub pages some double quotes have a leading backslash.

Solid work Morgan. Very simple to get started. Thanks!

mantoni · 2016-11-17T15:00:42Z

docs/_releases/v1.17.6/matchers.md

+Requires the value to be a `String`.
+
+
+#### `sinon.match.object"


Closing quote should be a backtick.

mantoni · 2016-11-17T15:02:31Z

docs/release-source/release/spies.md

+Replaces the spy with the original method. Only available if the spy replaced an existing method.
+
+
+#### `spy.printf(format string\", [arg1, arg2, ...])`


I guess it should be spy.printf("format string", [arg1, arg2, ...])

mroderick · 2016-11-17T16:52:55Z

@mantoni @fatso83 I've addressed all comments so far. I would prefer to merge all of this as one commit, so we don't end up with all the Review: commits in history

coveralls · 2016-11-17T17:17:13Z

Coverage remained the same at 96.319% when pulling d114ad4 on mroderick:docs-in-github-pages into 235abb4 on sinonjs:master.

fatso83 · 2016-12-07T22:22:08Z

Crap. Sorry that I held this up. I had no idea I was the one stalling it. And now it seems there have arisen some conflicts in the docs ...

mroderick · 2016-12-07T22:43:30Z

No worries, I wasn't sure myself. I'll rebate it tomorrow

mroderick · 2016-12-07T22:43:59Z

Rebase even. Damn autocorrect

coveralls · 2016-12-08T14:00:48Z

Coverage remained the same at 96.319% when pulling 7bd43c9 on mroderick:docs-in-github-pages into f6e7916 on sinonjs:master.

coveralls · 2016-12-08T14:00:48Z

Coverage remained the same at 96.319% when pulling 7bd43c9 on mroderick:docs-in-github-pages into f6e7916 on sinonjs:master.

mroderick · 2016-12-08T14:09:54Z

Rebased. I think this is good to go now

mroderick · 2016-12-14T16:18:35Z

Thanks!

mroderick added the Documentation label Nov 16, 2016

mroderick added this to the New sinon.org milestone Nov 16, 2016

mroderick force-pushed the docs-in-github-pages branch from d3124b5 to a87f59f Compare November 17, 2016 10:24

fatso83 requested changes Nov 17, 2016

View reviewed changes

mantoni reviewed Nov 17, 2016

View reviewed changes

fatso83 approved these changes Dec 7, 2016

View reviewed changes

Prepare documentation using site in GitHub Pages

7bd43c9

mroderick force-pushed the docs-in-github-pages branch from d114ad4 to 7bd43c9 Compare December 8, 2016 13:59

fatso83 merged commit e3d0836 into sinonjs:master Dec 8, 2016

mroderick deleted the docs-in-github-pages branch December 14, 2016 16:18

mroderick mentioned this pull request Jan 21, 2017

New documentation site #991

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare documentation using site in GitHub Pages #1189

Prepare documentation using site in GitHub Pages #1189

mroderick commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 17, 2016

coveralls commented Nov 17, 2016 •

edited

Loading

coveralls commented Nov 17, 2016 •

edited

Loading

fatso83 left a comment

fatso83 Nov 17, 2016

mroderick Nov 17, 2016

mroderick Nov 17, 2016

mroderick Nov 17, 2016

fatso83 Nov 17, 2016

mroderick Nov 17, 2016

mantoni commented Nov 17, 2016

mantoni Nov 17, 2016

mroderick Nov 17, 2016

mantoni Nov 17, 2016

mroderick Nov 17, 2016

mroderick commented Nov 17, 2016

coveralls commented Nov 17, 2016 •

edited

Loading

fatso83 commented Dec 7, 2016

mroderick commented Dec 7, 2016

mroderick commented Dec 7, 2016

coveralls commented Dec 8, 2016 •

edited

Loading

coveralls commented Dec 8, 2016

mroderick commented Dec 8, 2016

mroderick commented Dec 14, 2016

		Requires the value to be a `String`.


		#### `sinon.match.object"

		Replaces the spy with the original method. Only available if the spy replaced an existing method.


		#### `spy.printf(format string\", [arg1, arg2, ...])`

Prepare documentation using site in GitHub Pages #1189

Prepare documentation using site in GitHub Pages #1189

Conversation

mroderick commented Nov 16, 2016 • edited Loading

To verify

coveralls commented Nov 16, 2016 • edited Loading

coveralls commented Nov 16, 2016 • edited Loading

coveralls commented Nov 17, 2016

coveralls commented Nov 17, 2016 • edited Loading

coveralls commented Nov 17, 2016 • edited Loading

fatso83 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mantoni commented Nov 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroderick commented Nov 17, 2016

coveralls commented Nov 17, 2016 • edited Loading

fatso83 commented Dec 7, 2016

mroderick commented Dec 7, 2016

mroderick commented Dec 7, 2016

coveralls commented Dec 8, 2016 • edited Loading

coveralls commented Dec 8, 2016

mroderick commented Dec 8, 2016

mroderick commented Dec 14, 2016

mroderick commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 16, 2016 •

edited

Loading

coveralls commented Nov 17, 2016 •

edited

Loading

coveralls commented Nov 17, 2016 •

edited

Loading

coveralls commented Nov 17, 2016 •

edited

Loading

coveralls commented Dec 8, 2016 •

edited

Loading