From 807ac5c809617f82f34f5de2d24e5ff190eef598 Mon Sep 17 00:00:00 2001 From: Nathakit Date: Thu, 2 Mar 2017 18:18:11 +0700 Subject: [PATCH 01/23] add hololens and bt300 to vrar page --- templates/vr-ar.jade | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/templates/vr-ar.jade b/templates/vr-ar.jade index 60b39329..84c3aeb1 100644 --- a/templates/vr-ar.jade +++ b/templates/vr-ar.jade @@ -48,7 +48,7 @@ block main div.Feature h1 Hardware Add-Ons div.Grid-cell.Grid-cell--full.u-textCenter - div.Grid.Grid--gutters.Grid--1of3.Grid--bottom + div.Grid.Grid--gutters.Grid--1of2.Grid--bottom div.Grid-cell div.Feature figure.Feature-figure @@ -57,8 +57,15 @@ block main div.Grid-cell div.Feature figure.Feature-figure - img(class="Feature-image" src="../media/images/store_vr_ar/epsonbt200b.png" title="Epson BT-200 Add-on" alt="Epson BT-200 Add-on") - p #[a(href="/store#vr-ar" title="Pupil Labs Store Epson BT-200 add-on") Epson BT-200 Add-on] + img(class="Feature-image" src="../media/images/store_vr_ar/addon_hololens.jpg" title="Microsoft Hololens Add-on" alt="Microsoft Hololens Binocular Add-on") + p #[a(href="/store#vr-ar" title="Pupil Labs Store Microsoft Hololens Binocular Add-on") Microsoft Hololens Binocular Add-on] + div.Grid-cell.Grid-cell--full.u-textCenter + div.Grid.Grid--gutters.Grid--1of2.Grid--bottom + div.Grid-cell + div.Feature + figure.Feature-figure + img(class="Feature-image" src="../media/images/store_vr_ar/addon_epson_bt300b.jpg" title="Epson BT-300 Add-on" alt="Epson BT-300 Add-on") + p #[a(href="/store#vr-ar" title="Pupil Labs Store Epson BT-300 add-on") Epson BT-300 Add-on] div.Grid-cell div.Feature figure.Feature-figure From 91a6fd1cd26ae24f0fab85380bd768cb4ffea462 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 3 Mar 2017 14:42:53 +0700 Subject: [PATCH 02/23] updating title of blog post --- contents/articles/2017-03_hololens-bt300-addon/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/articles/2017-03_hololens-bt300-addon/index.md b/contents/articles/2017-03_hololens-bt300-addon/index.md index 0cc69549..9ca63ee7 100644 --- a/contents/articles/2017-03_hololens-bt300-addon/index.md +++ b/contents/articles/2017-03_hololens-bt300-addon/index.md @@ -1,5 +1,5 @@ --- -title: Hololens and BT300 VR/AR Addon +title: Hololens and BT300 eye tracking add-ons date: Thu Mar 02 2017 15:28:39 GMT+0700 (ICT) author: Pupil Dev Team subtitle: "New eye tracking add-ons for the Microsoft Hololens and the Epson Moverio BT-300 - now available on the store!" From 38bdb0297c495f56a0922db8da5562e17174b27c Mon Sep 17 00:00:00 2001 From: Will Patera Date: Tue, 7 Mar 2017 09:04:23 +0700 Subject: [PATCH 03/23] update zip format for chile --- assets/coffeescript/country_list.coffee | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/assets/coffeescript/country_list.coffee b/assets/coffeescript/country_list.coffee index fbf33aab..fd98ceb8 100644 --- a/assets/coffeescript/country_list.coffee +++ b/assets/coffeescript/country_list.coffee @@ -323,8 +323,8 @@ countryList = countryISO: 'CL' countryName: 'Chile' locationFormat: 'City' - usesPostalCode: false - postalCodeFormat: null + usesPostalCode: true + postalCodeFormat: '9999999' capitalCity: 'Santiago' inEU: false Cameroon: From a1fce996cd34e8e7402e0db9b1d3c9c55b3d3fa5 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Tue, 7 Mar 2017 09:05:08 +0700 Subject: [PATCH 04/23] fixing typo in careers post --- contents/careers/positions/sales_ops.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/careers/positions/sales_ops.md b/contents/careers/positions/sales_ops.md index 6a5a738d..9d2f0f36 100644 --- a/contents/careers/positions/sales_ops.md +++ b/contents/careers/positions/sales_ops.md @@ -6,4 +6,4 @@ jobTitle: sales-ops We are looking to hire a part time employee to join our sales and operations team. Remote work is OK pending experience. On-site work in Bangkok is preferred. -You are an precise and efficient communicator. You are eager to learn new workflows. You have experience in technical support and/or sales. You are 100% fluent in written and spoken English. \ No newline at end of file +You are a precise and efficient communicator. You are eager to learn new workflows. You have experience in technical support and/or sales. You are 100% fluent in written and spoken English. \ No newline at end of file From 20d79cb335ea33239e2d2f963ead593431ca5c60 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Tue, 14 Mar 2017 16:39:58 +0700 Subject: [PATCH 05/23] add v0.9.2 release for blog --- .../2017-03_pupil-v092-release_notes/index.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contents/articles/2017-03_pupil-v092-release_notes/index.md diff --git a/contents/articles/2017-03_pupil-v092-release_notes/index.md b/contents/articles/2017-03_pupil-v092-release_notes/index.md new file mode 100644 index 00000000..8a9a5b90 --- /dev/null +++ b/contents/articles/2017-03_pupil-v092-release_notes/index.md @@ -0,0 +1,27 @@ +--- +title: Pupil Capture, Player, and Service Release v0.9.2 +date: Friday Mar 10 2017 15:34:00 GMT+0700 (ICT) +author: Pupil Dev Team +subtitle: "We pleased to announce the latest release of the Pupil Platform v0.9.2..." +tag: {"caption":"v0.9.2","icon":"local_offer"} +--- + + + From d562ff21496fc7d84b2d235c2bf97144eddf7b8b Mon Sep 17 00:00:00 2001 From: Will Patera Date: Mon, 27 Mar 2017 14:11:28 +0200 Subject: [PATCH 06/23] update links for wiki Old links from releases will still link to the old wiki --- contents/articles/2016-11_pupil-lsl-plugin/index.md | 2 +- contents/pupil/features/communitylicense/community.md | 9 +++++---- contents/pupil/features/modular-hackable.md | 4 ++-- contents/pupil/features/open-source-software.md | 4 ++-- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/contents/articles/2016-11_pupil-lsl-plugin/index.md b/contents/articles/2016-11_pupil-lsl-plugin/index.md index ce2379d2..8656ef49 100644 --- a/contents/articles/2016-11_pupil-lsl-plugin/index.md +++ b/contents/articles/2016-11_pupil-lsl-plugin/index.md @@ -13,7 +13,7 @@ featured_img_thumb: "../../../../media/images/blog/thumb/Lab-Streaming-Layer.jpg
Image Source: [Qusp Product Portfolio](https://qusp.io/projects)
-We are excited to introduce the [Pupil + Lab Streaming Layer relay plugin](https://github.com/sccn/labstreaminglayer/tree/master/Apps/PupilLabs). The plugin works with [Pupil Capture](https://github.com/pupil-labs/pupil/wiki/Pupil-Capture) to relay pupil data, gaze data, and notifications to LSL. Users can link the data to other inlets in the network. +We are excited to introduce the [Pupil + Lab Streaming Layer relay plugin](https://github.com/sccn/labstreaminglayer/tree/master/Apps/PupilLabs). The plugin works with [Pupil Capture](http://docs.pupil-labs.com/#pupil-capture "Pupil Docs - Pupil Capture") to relay pupil data, gaze data, and notifications to LSL. Users can link the data to other inlets in the network. The [Lab Streaming Layer](https://github.com/sccn/labstreaminglayer) (LSL) is a system that provides unified collection of measurement time series between programs, computers, and devices over a network for distributed signal transport, time synchronization, and data collection. LSL has an extensive range of supported measurement modalities including eye tracking. diff --git a/contents/pupil/features/communitylicense/community.md b/contents/pupil/features/communitylicense/community.md index 51dd304e..1a5df6c1 100644 --- a/contents/pupil/features/communitylicense/community.md +++ b/contents/pupil/features/communitylicense/community.md @@ -10,13 +10,14 @@ Start developing on your own [fork][2] the code on Github. Read the [docs][3] and contribute to the [user guide][4]. -Discuss your project and get free support on the [Pupil Google Group][5]. +Chat with the community on [Discord][7]. Discuss your project and get free support on the [Pupil Google Group][5]. Report bugs and request features on [Github][6]. [1]: https://github.com/pupil-labs/pupil/network "Github Network Graph" [2]: https://github.com/pupil-labs/pupil "Pupil Code Repo" -[3]: https://github.com/pupil-labs/pupil/wiki "Pupil Wiki" -[4]: https://github.com/pupil-labs/pupil/wiki/User-Guide "Pupil User Guide" +[3]: http://docs.pupil-labs.com/ "Pupil Docs" +[4]: http://docs.pupil-labs.com/#user-docs "Pupil Docs - User Docs" [5]: https://groups.google.com/forum/#!forum/pupil-discuss "Pupil Google Group" -[6]: http://github.com/pupil-labs/pupil/issues "Pupil Issue Tracker" \ No newline at end of file +[6]: http://github.com/pupil-labs/pupil/issues "Pupil Issue Tracker" +[7]: https://discord.gg/gKmmGqy "Pupil - Discord Invite" \ No newline at end of file diff --git a/contents/pupil/features/modular-hackable.md b/contents/pupil/features/modular-hackable.md index ae595fd4..0c6dff98 100644 --- a/contents/pupil/features/modular-hackable.md +++ b/contents/pupil/features/modular-hackable.md @@ -12,8 +12,8 @@ We also like work with users to create custom solutions. [Get in touch][2]! If you're excited about SMD soldering and hacking: you can [buy a DEV frame][5], [buy parts][4], and [follow assembly instructions][3] to build your own Pupil DEV headset. -[1]: https://github.com/pupil-labs/pupil/wiki/Pupil%20Hardware%20Development "Pupil Hardware Development" +[1]: http://docs.pupil-labs.com/#pupil-hardware-development "Pupil Docs - Pupil Hardware Development" [2]: mailto:sales@pupil-labs.com -[3]: https://github.com/pupil-labs/pupil/wiki/DIY-Kit-Guide "DIY Guide" +[3]: http://docs.pupil-labs.com/#diy "Pupil Docs - DIY Guide" [4]: https://docs.google.com/spreadsheets/d/1NRv2WixyXNINiq1WQQVs5upn20jakKyEl1R8NObrTgU/pub?single=true&gid=0&output=html "BOM" [5]: https://www.shapeways.com/product/LQJJK2CHQ/pupil-mobile-eye-tracking-headset "DEV Frame on Shapeways" diff --git a/contents/pupil/features/open-source-software.md b/contents/pupil/features/open-source-software.md index eb239d99..031bce39 100644 --- a/contents/pupil/features/open-source-software.md +++ b/contents/pupil/features/open-source-software.md @@ -12,7 +12,7 @@ We have developed a plugin structure that enables you to extend Pupil Capture an Check out the [pupil repository][1] on Github -Read [developer documentation][2] on the wiki. +Read [developer docs][2]. [1]: https://github.com/pupil-labs/pupil "Pupil Repository on Github" -[2]: https://github.com/pupil-labs/pupil/wiki/Developer-Guide "Developer Wiki Page" +[2]: http://docs.pupil-labs.com/#developer-docs "Developer Docs" From 8d92ca7da30ade4e2bb4cfa3c3b7317b3edc2bff Mon Sep 17 00:00:00 2001 From: Will Patera Date: Mon, 27 Mar 2017 14:12:45 +0200 Subject: [PATCH 07/23] update wiki links in templates --- templates/pupil.jade | 6 +++--- templates/vr-ar.jade | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/templates/pupil.jade b/templates/pupil.jade index 6007f7da..1a9fc553 100644 --- a/templates/pupil.jade +++ b/templates/pupil.jade @@ -176,7 +176,7 @@ block main h4 We believe in open source. All Pupil code is released with open source licenses. h4 A lot of work went into making the software modular and accessible. The majority of the codebase is written in Python. h4 We have developed a plugin structure that enables you to extend Pupil Capture and Pupil Player to suit your needs. - h4 Check out the pupil repository on #[a(href="https://github.com/pupil-labs/pupil/" rel="noopener" title="Pupil repository on github") Github]. Read developer documentation on the #[a(href="https://github.com/pupil-labs/pupil/wiki" rel="noopener" title="Pupil Wiki") wiki]. + h4 Check out the pupil repository on #[a(href="https://github.com/pupil-labs/pupil/" rel="noopener" title="Pupil repository on github") Github]. Read developer documentation on #[a(href="http://docs.pupil-labs.com/" rel="noopener" title="Pupil Docs") docs.pupil-labs.com]. div.Grid-cell div.Feature figure.Feature-figure @@ -214,10 +214,10 @@ block main div.Grid-cell div.Feature h1 Modular & Hackable - h4 If we don't have the configuration you need, customize it yourself. Our camera mount geometry and electrical interface is #[a(href="https://github.com/pupil-labs/pupil/wiki/Pupil%20Hardware%20Development" rel="noopener" title="Pupil Wiki - Hardware Development") open]. + h4 If we don't have the configuration you need, customize it yourself. Our camera mount geometry and electrical interface is #[a(href="http://docs.pupil-labs.com/#pupil-hardware-development" rel="noopener" title="Pupil Docs - Hardware Development") open]. h4 We also like to work with users to create custom solutions. #[a(href="mailto:sales@pupil-labs.com" rel="noopener" title="Get in touch") Get in touch!] h4 If you're excited about SMD soldering and hacking: you can make your own Pupil DIY. - h4 #[a(href="https://www.shapeways.com/product/LQJJK2CHQ/pupil-mobile-eye-tracking-headset" rel="noopener" title="Pupil DIY frame on Shapeways") Buy the frame], #[a(href="https://docs.google.com/spreadsheets/d/1NRv2WixyXNINiq1WQQVs5upn20jakKyEl1R8NObrTgU/pub?single=true&gid=0&output=html" rel="noopener" title="Source parts") source parts], and #[a(href="https://github.com/pupil-labs/pupil/wiki/DIY-Kit-Guide" rel="noopener" title="Pupil DIY guide") follow assembly instructions] to build your own Pupil DIY headset. + h4 #[a(href="https://www.shapeways.com/product/LQJJK2CHQ/pupil-mobile-eye-tracking-headset" rel="noopener" title="Pupil DIY frame on Shapeways") Buy the frame], #[a(href="https://docs.google.com/spreadsheets/d/1NRv2WixyXNINiq1WQQVs5upn20jakKyEl1R8NObrTgU/pub?single=true&gid=0&output=html" rel="noopener" title="Source parts") source parts], and #[a(href="http://docs.pupil-labs.com/#diy" rel="noopener" title="Pupil Docs - DIY") follow assembly instructions] to build your own Pupil DIY headset. //- Commercial Use & Dedicated Support diff --git a/templates/vr-ar.jade b/templates/vr-ar.jade index 84c3aeb1..5675134c 100644 --- a/templates/vr-ar.jade +++ b/templates/vr-ar.jade @@ -182,7 +182,7 @@ block main td tr td.Table--column SDK - td #[a(href="https://github.com/pupil-labs/pupil/wiki/Pupil-Interprocess-and-Network-Communication" title="Pupil Interprocess and Network Communication" rel="noopener") Through network message based API] + td #[a(href="http://docs.pupil-labs.com/#interprocess-and-network-communication" title="Pupil Docs - Interprocess and Network Communication" rel="noopener") Through network message based API] tr td.Table--column Plugin for Game Engines td #[a(href="https://github.com/pupil-labs/hmd-eyes" title="HMD Eyes" rel="noopener") Reference plugin] implementation for Unity3D From 58611625f90d99a88ac40b6d4081b88bcd72c6b2 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Mon, 27 Mar 2017 16:15:13 +0200 Subject: [PATCH 08/23] update docs link in head nav --- contents/menu/header-nav.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/menu/header-nav.json b/contents/menu/header-nav.json index e3d6a683..5bc30426 100644 --- a/contents/menu/header-nav.json +++ b/contents/menu/header-nav.json @@ -2,7 +2,7 @@ "pupil": "/pupil", "vr/ar": "/vr-ar", "store": "/store", - "docs": "/docs", + "docs": "docs.pupil-labs.com", "blog": "/blog", "about": "/about", "careers": "/careers", From f2c106678682d0b4f0ef3e516c039b4e764d6e29 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Mon, 27 Mar 2017 17:37:08 +0200 Subject: [PATCH 09/23] update docs link --- contents/menu/header-nav.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/menu/header-nav.json b/contents/menu/header-nav.json index 5bc30426..084c4578 100644 --- a/contents/menu/header-nav.json +++ b/contents/menu/header-nav.json @@ -2,7 +2,7 @@ "pupil": "/pupil", "vr/ar": "/vr-ar", "store": "/store", - "docs": "docs.pupil-labs.com", + "docs": "http://docs.pupil-labs.com", "blog": "/blog", "about": "/about", "careers": "/careers", From 1379d68f8d9cd7c963568ce90f4237e60c060c48 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Mon, 27 Mar 2017 17:43:50 +0200 Subject: [PATCH 10/23] add v0.9.3 post and fix typos in old post --- .../index.md | 27 +++++++++++++++++++ .../2017-03_pupil-v092-release_notes/index.md | 2 +- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 contents/articles/2017-03_pupil-v0.9.3-release-notes/index.md diff --git a/contents/articles/2017-03_pupil-v0.9.3-release-notes/index.md b/contents/articles/2017-03_pupil-v0.9.3-release-notes/index.md new file mode 100644 index 00000000..f344bba3 --- /dev/null +++ b/contents/articles/2017-03_pupil-v0.9.3-release-notes/index.md @@ -0,0 +1,27 @@ +--- +title: Pupil v0.9.3 release notes +date: Mon Mar 21 2017 17:39:47 GMT+0200 (CEST) +author: Pupil Dev Team +subtitle: "We are pleased to announce the latest release of the Pupil Platform v0.9.3..." +tag: {"caption":"v0.9.3","icon":"local_offer"} +--- + + + diff --git a/contents/articles/2017-03_pupil-v092-release_notes/index.md b/contents/articles/2017-03_pupil-v092-release_notes/index.md index 8a9a5b90..75c96ccb 100644 --- a/contents/articles/2017-03_pupil-v092-release_notes/index.md +++ b/contents/articles/2017-03_pupil-v092-release_notes/index.md @@ -2,7 +2,7 @@ title: Pupil Capture, Player, and Service Release v0.9.2 date: Friday Mar 10 2017 15:34:00 GMT+0700 (ICT) author: Pupil Dev Team -subtitle: "We pleased to announce the latest release of the Pupil Platform v0.9.2..." +subtitle: "We are pleased to announce the latest release of the Pupil Platform v0.9.2..." tag: {"caption":"v0.9.2","icon":"local_offer"} --- From 560400683646ac17671d3b828d5c03d9ec395bee Mon Sep 17 00:00:00 2001 From: Will Patera Date: Tue, 28 Mar 2017 18:23:03 +0200 Subject: [PATCH 11/23] draft blog post for pupil-docs --- .../2017-03_new-docs-website/index.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 contents/articles/2017-03_new-docs-website/index.md diff --git a/contents/articles/2017-03_new-docs-website/index.md b/contents/articles/2017-03_new-docs-website/index.md new file mode 100644 index 00000000..b8866523 --- /dev/null +++ b/contents/articles/2017-03_new-docs-website/index.md @@ -0,0 +1,73 @@ +--- +title: New docs website +date: Mon Mar 27 2017 17:44:45 GMT+0200 (CEST) +author: Pupil Dev Team +subtitle: 'We have transitioned docs to docs.pupil-labs.com' +featured_img_thumb: '' +--- + +All Pupil documentation - user docs, developer docs, and more - are now at [docs.pupil-labs.com](docs.pupil-labs.com). + + + +## Github wiki --> docs.pupil-labs.com + +Why did we decide to transition away from a Github wiki to our own static docs website? + +Github wikis are great because they there is very little overhead for both maintainers and contributors. You can get started quickly and focus on editing content without worring about hosting, markdown parsing, or styling. These conveniences come with some comprimises. With a Github wiki you are not allowed to: embed videos, add your own css, declare any inline styles, or use javascript. You are constrained to basic HTML and whatever styling is provided by Github flavored markdown. + +Github wikis are stored as git repos. This is great, because you can track changes, make branches, tag versions, and do whatever else you want to do with git's powers. But, the wiki git repo is immediately visible to users/contributors from the Github web interface. This means that you can not make issues, make PRs, publish releases, visualize forks, etc. + +In short, we felt ourselves outgrowing the constraints of the Github powered wikis and wanted to be able to have a docs site that could satisfy the following desires: + +- Markdown - Continue writing content in markdown. +- Versioning - Host multiple versions and branches of docs. Version tags should be synchronized with Pupil version tags. The `master` branch should always be the most current development branch. +- Content vs Logic - Separate the docs content from the website generation logic and styling. Changes in style or website generation should be separate from docs. +- Style - Have full control of styles, be able to embed videos, call APIs, etc. +- Single page - Everything in one place; all docs on a single page. At first this may seem overwhelming, but enables one to easiliy `cmd + F` to find anything. +- Github - Leverage the full power of Github's existing tools to visualize and track changes, make issues, assign tasks, show forks, etc. + +## Editing docs + +Anyone can edit content. Just make a fork of the [pupil-docs](https://github.com/pupil-labs/pupil-docs "pupil-docs repo") repo, edit, and make a PR. + +## Pupil Docs Website + +To generate the website we are using [`Hugo`](https://gohugo.io/ "Hugo - Static site generator") - static site generator written in `Go`. Hugo is fast and has a lot of nice built-in functions. + +The css, javascript, and layout template files are isolated as a fork of the [docuapi theme](https://github.com/pupil-labs/docuapi), which in turn uses [Slate](https://github.com/lord/slate) to generate the table of contents, search functionality, and all base css styles. + +The `docuapi` theme and our content repo that holds all markdown files are both submodules of pupil-docs-website. The structure looks like this: + +``` +/pupil-docs-website - github.com/pupil-labs/pupil-docs-website +|-- content - github.com/pupil-labs/pupil-docs +|-- themes +| `-- docuapi - github.com/pupil-labs/docuapi +``` + +## Versioning + +Hugo supports multiple languages of content by adding a language suffix for each file. Typical usage of this feature would look like this: `introduction.en.md` for English language content and `introduction.de.md` for that same content in German. Names of languages and their order or "weight" are defined in Hugo's `config.toml` file. In the above example, Hugo would create a subdirectory for each non-default language such that `example.com/` could be the English language website and `example.com/de/` would host the German language website. + +We (ab)use the multi-language feature so that we can build docs tags and branches. The most recent/current branch is always `master`. Here's an example: + +- docs.pupil-labs.com/ - the most recent "stable" tag e.g. `v0.9.3` +- docs.pupil-labs.com/v092 +- docs.pupil-labs.com/v091 +- docs.pupil-labs.com/master - the master branch - always the most recent changes to docs + +To support this workflow we have written a script runs before we build the static site - [`tag.sh`](https://github.com/pupil-labs/pupil-docs-website/blob/master/scripts/tag.sh). This script gets the most recent X number of tags and specified branches, renames files with their tag or branch name (e.g. `introduction.master.md` or `introduction.v093.md`), and updates the hugo `config.toml` file with the appropriate language settings. + +## CI + +We use [travis-ci](https://travis-ci.org/pupil-labs/pupil-docs-website "pupil-docs-website - travis-ci") to build and deploy the website with each change. + +We wrote a [custom hook](https://github.com/pupil-labs/pupil-docs/blob/master/scripts/webhook.sh) so that every time a commit is made to the `pupil-docs` repository it will trigger a build for `pupil-docs-website`. + +## Next steps + +We are happy with this transition, but also realize that it is a big shift for the community. There is still a lot to do, and we need help from the community to help us continue to improve docs. + +You can help by forking `pupil-docs`, making pull requests, making issues on either [pupil-docs](https://github.com/pupil-labs/pupil-docs), [pupil-docs-website](https://github.com/pupil-labs/pupil-docs-website), or [docuapi](https://github.com/pupil-labs/docuapi). + From b1232ec9047cf1a2375e81e060c138be689d5341 Mon Sep 17 00:00:00 2001 From: Nathakit Date: Wed, 29 Mar 2017 13:57:02 +0700 Subject: [PATCH 12/23] add img path to pupil docs website screenshot --- contents/articles/2017-03_new-docs-website/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/articles/2017-03_new-docs-website/index.md b/contents/articles/2017-03_new-docs-website/index.md index b8866523..543aac86 100644 --- a/contents/articles/2017-03_new-docs-website/index.md +++ b/contents/articles/2017-03_new-docs-website/index.md @@ -8,7 +8,7 @@ featured_img_thumb: '' All Pupil documentation - user docs, developer docs, and more - are now at [docs.pupil-labs.com](docs.pupil-labs.com). - +Pupil Docs Website ## Github wiki --> docs.pupil-labs.com From 2609142e7e0a0e8aad1e41715f7d3d3d1e0cc73e Mon Sep 17 00:00:00 2001 From: Will Patera Date: Wed, 29 Mar 2017 15:25:27 +0200 Subject: [PATCH 13/23] draft post for docs.pupil-labs.com --- contents/articles/2017-03_new-docs-website/index.md | 4 ++-- contents/media | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/contents/articles/2017-03_new-docs-website/index.md b/contents/articles/2017-03_new-docs-website/index.md index 543aac86..5f44268e 100644 --- a/contents/articles/2017-03_new-docs-website/index.md +++ b/contents/articles/2017-03_new-docs-website/index.md @@ -6,10 +6,10 @@ subtitle: 'We have transitioned docs to docs.pupil-labs.com' featured_img_thumb: '' --- -All Pupil documentation - user docs, developer docs, and more - are now at [docs.pupil-labs.com](docs.pupil-labs.com). - Pupil Docs Website +All Pupil documentation - user docs, developer docs, and more - are now at [docs.pupil-labs.com](https://docs.pupil-labs.com "Pupil docs"). + ## Github wiki --> docs.pupil-labs.com Why did we decide to transition away from a Github wiki to our own static docs website? diff --git a/contents/media b/contents/media index b496af5a..ca2d5aa2 160000 --- a/contents/media +++ b/contents/media @@ -1 +1 @@ -Subproject commit b496af5ac60f710b3b9a49024e9d1b110facd165 +Subproject commit ca2d5aa2cd06998ac40106c45e56f43ef5e109d8 From c380cce6d993b63a233b02ed2de78a92483c39f2 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 21 Apr 2017 13:54:26 +0700 Subject: [PATCH 14/23] add blog post for v0.9.6 release --- .../2017-04_pupil-v096-release-notes/index.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contents/articles/2017-04_pupil-v096-release-notes/index.md diff --git a/contents/articles/2017-04_pupil-v096-release-notes/index.md b/contents/articles/2017-04_pupil-v096-release-notes/index.md new file mode 100644 index 00000000..fe9940d3 --- /dev/null +++ b/contents/articles/2017-04_pupil-v096-release-notes/index.md @@ -0,0 +1,27 @@ +--- +title: Pupil Capture, Player, and Service Release v0.9.6 +date: Friday Apr 20 2017 15:34:00 GMT+0700 (ICT) +author: Pupil Dev Team +subtitle: "We are pleased to announce the latest release of the Pupil Platform v0.9.6..." +tag: {"caption":"v0.9.6","icon":"local_offer"} +--- + + + From abab727fd180895ba1eb3531e25d4c589744c082 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 21 Apr 2017 17:19:20 +0700 Subject: [PATCH 15/23] update docs site blog post --- contents/articles/2017-03_new-docs-website/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contents/articles/2017-03_new-docs-website/index.md b/contents/articles/2017-03_new-docs-website/index.md index 5f44268e..9b5c91da 100644 --- a/contents/articles/2017-03_new-docs-website/index.md +++ b/contents/articles/2017-03_new-docs-website/index.md @@ -3,10 +3,10 @@ title: New docs website date: Mon Mar 27 2017 17:44:45 GMT+0200 (CEST) author: Pupil Dev Team subtitle: 'We have transitioned docs to docs.pupil-labs.com' -featured_img_thumb: '' +featured_img_thumb: '../../../../media/images/blog/pupil-docs-web.jpg' --- -Pupil Docs Website +Pupil Docs Website All Pupil documentation - user docs, developer docs, and more - are now at [docs.pupil-labs.com](https://docs.pupil-labs.com "Pupil docs"). From e42685c28bac3d0790e36a71815fa0de4062dec9 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 21 Apr 2017 17:19:44 +0700 Subject: [PATCH 16/23] update submodule --- contents/media | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/media b/contents/media index ca2d5aa2..28f5e670 160000 --- a/contents/media +++ b/contents/media @@ -1 +1 @@ -Subproject commit ca2d5aa2cd06998ac40106c45e56f43ef5e109d8 +Subproject commit 28f5e670108ace5f45b726525ce3fc67f9ff0806 From 7e195a211d70b90b3ac9a401d89157612b923e90 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 21 Apr 2017 17:20:26 +0700 Subject: [PATCH 17/23] update dependencies --- package.json | 1 + yarn.lock | 18 +++++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/package.json b/package.json index a9b7e385..f4076fa0 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "author": "Will Patera ", "license": "CC-BY-NC-SA-4.0", "dependencies": { + "global": "^4.3.2", "moment": "^2.17.1", "typogr": "^0.6.6", "underscore": "^1.8.3", diff --git a/yarn.lock b/yarn.lock index 325db93a..f53563a2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1964,9 +1964,9 @@ global-prefix@^0.1.4: is-windows "^0.2.0" which "^1.2.12" -global@~4.3.0: - version "4.3.1" - resolved "https://registry.yarnpkg.com/global/-/global-4.3.1.tgz#5f757908c7cbabce54f386ae440e11e26b7916df" +global@^4.3.2, global@~4.3.0: + version "4.3.2" + resolved "https://registry.yarnpkg.com/global/-/global-4.3.2.tgz#e76989268a6c74c38908b1305b10fc0e394e9d0f" dependencies: min-document "^2.19.0" process "~0.5.1" @@ -4096,7 +4096,7 @@ read@1, read@~1.0.1, read@~1.0.7: dependencies: mute-stream "~0.0.4" -"readable-stream@1 || 2", readable-stream@^2.0.2, readable-stream@^2.1.5, readable-stream@~2.1.4, readable-stream@~2.1.5: +"readable-stream@1 || 2", "readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.2, readable-stream@^2.1.5, readable-stream@~2.1.4, readable-stream@~2.1.5: version "2.1.5" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.1.5.tgz#66fa8b720e1438b364681f2ad1a63c618448c9d0" dependencies: @@ -4126,7 +4126,7 @@ readable-stream@1.1, readable-stream@~1.1.9: isarray "0.0.1" string_decoder "~0.10.x" -"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.2.2: +readable-stream@^2.2.2: version "2.2.2" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.2.tgz#a9e6fec3c7dda85f8bb1b3ba7028604556fc825e" dependencies: @@ -4260,7 +4260,7 @@ request-progress@~2.0.1: dependencies: throttleit "^1.0.0" -request@2, request@2.78.0, request@^2.65.0, request@^2.74.0: +request@2, request@2.78.0, request@^2.65.0, request@^2.73.0, request@^2.74.0: version "2.78.0" resolved "https://registry.yarnpkg.com/request/-/request-2.78.0.tgz#e1c8dec346e1c81923b24acdb337f11decabe9cc" dependencies: @@ -4285,7 +4285,7 @@ request@2, request@2.78.0, request@^2.65.0, request@^2.74.0: tough-cookie "~2.3.0" tunnel-agent "~0.4.1" -request@^2.73.0, request@^2.79.0, request@~2.79.0: +request@^2.79.0, request@~2.79.0: version "2.79.0" resolved "https://registry.yarnpkg.com/request/-/request-2.79.0.tgz#4dfe5bf6be8b8cdc37fcf93e04b65577722710de" dependencies: @@ -4462,11 +4462,11 @@ sax@>=0.6.0: version "1.2.1" resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.1.tgz#7b8e656190b228e81a66aea748480d828cd2d37a" -"semver@2 >=2.2.1 || 3.x || 4 || 5", "semver@2 || 3 || 4 || 5", "semver@2.x || 3.x || 4 || 5", "semver@^2.3.0 || 3.x || 4 || 5", semver@^5.1.0, semver@^5.2.0, semver@^5.3.0, semver@~5.3.0: +"semver@2 >=2.2.1 || 3.x || 4 || 5", "semver@2 || 3 || 4 || 5", "semver@^2.3.0 || 3.x || 4 || 5", semver@^5.1.0, semver@^5.2.0, semver@^5.3.0, semver@~5.3.0: version "5.3.0" resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f" -semver@^4.1.0: +"semver@2.x || 3.x || 4 || 5", semver@^4.1.0: version "4.3.6" resolved "https://registry.yarnpkg.com/semver/-/semver-4.3.6.tgz#300bc6e0e86374f7ba61068b5b1ecd57fc6532da" From eb7f9249e08593c78d22c4ce3f6b4a5bb51542e4 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Fri, 28 Apr 2017 12:18:06 +0700 Subject: [PATCH 18/23] update team and imprint --- contents/about/imprint.md | 14 ++++++++++++++ contents/about/team.json | 21 ++++++++++++++++++--- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/contents/about/imprint.md b/contents/about/imprint.md index b12c3ef5..35786b26 100644 --- a/contents/about/imprint.md +++ b/contents/about/imprint.md @@ -1,6 +1,8 @@ --- title: Imprint --- +

Pupil Labs - Berlin

+

Address

Pupil Labs UG (haftungsbeschränkt) Gustav-Müller-Str. 7 10829 Berlin

@@ -22,3 +24,15 @@ title: Imprint

gemäß § 27 a Umsatzsteuergesetz: DE293673193

Responsible for Content (nach § 10 Absatz 3 MDStV): Moritz Kassner (Address as above)

+ +
+ +

Pupil Labs - Bangkok

+ +

Address

+ +

Pupil Labs, 29/5 Soi Phrom Chit, 2nd Floor, Khlong Tan Nua, Wattana, 10110, Bangkok, Thailand

+ +

Managing Partner

+ +

Will Patera

\ No newline at end of file diff --git a/contents/about/team.json b/contents/about/team.json index 8ca98286..f718c520 100644 --- a/contents/about/team.json +++ b/contents/about/team.json @@ -2,13 +2,13 @@ { "name":"Moritz Kassner", "contact": "moritz@pupil-labs.com", - "role":"Co-Founder, CEO", + "role":"Founding Partner, CEO", "img":"https://placehold.it/400x400" }, { "name":"Will Patera", "contact":"will@pupil-labs.com", - "role":"Co-Founder", + "role":"Founding Partner", "img":"https://placehold.it/400x400" }, { @@ -24,7 +24,7 @@ }, { "name":"Marc Tonsen", - "role":"Research and Development Engineer", + "role":"Research & Development Engineer", "img":"https://placehold.it/400x400" }, { @@ -46,5 +46,20 @@ "name":"Ines Findewirth", "role":"Office Manager", "img":"https://placehold.it/400x400" + }, + { + "name":"Kai Dierkes", + "role":"Research & Development Engineer", + "img":"https://placehold.it/400x400" + }, + { + "name":"Niall Oakes", + "role":"Hardware & Fulfillment", + "img":"https://placehold.it/400x400" + }, + { + "name":"Francesco Gennari", + "role":"Hardware & Fulfillment", + "img":"https://placehold.it/400x400" } ] \ No newline at end of file From 6621c552d568e8d2c6f343b67d36fc5555a1cdd8 Mon Sep 17 00:00:00 2001 From: Nathakit Sae-Tan Date: Wed, 17 May 2017 17:35:00 +0700 Subject: [PATCH 19/23] add cognitive vr blogpost --- .../articles/2017-05_cognitive-vr/index.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 contents/articles/2017-05_cognitive-vr/index.md diff --git a/contents/articles/2017-05_cognitive-vr/index.md b/contents/articles/2017-05_cognitive-vr/index.md new file mode 100644 index 00000000..1cba6e0d --- /dev/null +++ b/contents/articles/2017-05_cognitive-vr/index.md @@ -0,0 +1,20 @@ +--- +title: cognitiveVR +date: Wed May 17 2017 14:10:45 GMT+0200 (CEST) +author: Pupil Dev Team +subtitle: 'Pupil Labs Vive Add-On with cognitiveVR' +featured_img: "../../../../media/images/blog/cognitive-vr.jpg" +featured_img_thumb: "../../../../media/images/blog/thumb/cognitive-vr.jpg" +--- + +[cognitiveVR](http://cognitivevr.co/) is a powerful analytics platform for virtual reality to give content creators the ability to make better VR. Helping companies extract value from VR experiences by providing the tools to record, measure and analyze. + +
+ +
+ +
Pupil Labs Vive Add-On with cognitiveVR
+ +This demo showcases [Pupil Labs Vive Add-On](https://pupil-labs.com/store/#vr-ar) tracking gaze movement in a VR environment running cognitiveVR in Unity. Software development kit for [Unity SDK](https://docs.cognitivevr.io/unity/get-started/) have been released by cognitiveVR for users to integrate their Unity projects with [HTC Vive](https://www.vive.com) and [Pupil Labs Vive Add-On](https://pupil-labs.com/store/#vr-ar). Along with multiple [VR SDKs](https://docs.cognitivevr.io/unity/hmd-specific-info/#multiple-sdks) in Unity to work with. + +For more information on how to use Pupil Labs eye tracking with cognitiveVR, head over to [cognitiveVR documentation](https://docs.cognitivevr.io/unity/hmd-specific-info/#pupil-labs-vive-add-on). \ No newline at end of file From 577ff0b59eaa56eb153a7d234bfeea0de6986009 Mon Sep 17 00:00:00 2001 From: Nathakit Sae-Tan Date: Wed, 17 May 2017 17:42:42 +0700 Subject: [PATCH 20/23] add release note blogpost for v0.9.10 --- .../index.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contents/articles/2017-05_pupil-v0910-release-notes/index.md diff --git a/contents/articles/2017-05_pupil-v0910-release-notes/index.md b/contents/articles/2017-05_pupil-v0910-release-notes/index.md new file mode 100644 index 00000000..1429fee1 --- /dev/null +++ b/contents/articles/2017-05_pupil-v0910-release-notes/index.md @@ -0,0 +1,27 @@ +--- +title: Pupil Capture, Player, and Service Release v0.9.10 +date: Wed May 18 2017 17:34:00 GMT+0700 (ICT) +author: Pupil Dev Team +subtitle: "We are pleased to announce the latest release of the Pupil Platform v0.9.10..." +tag: {"caption":"v0.9.10","icon":"local_offer"} +--- + + + \ No newline at end of file From d94b4499479fce333514eb80b6404af9f64617af Mon Sep 17 00:00:00 2001 From: Nathakit Sae-Tan Date: Thu, 18 May 2017 11:24:38 +0700 Subject: [PATCH 21/23] update blogpost as requested from WRP --- contents/articles/2017-05_cognitive-vr/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contents/articles/2017-05_cognitive-vr/index.md b/contents/articles/2017-05_cognitive-vr/index.md index 1cba6e0d..91115aae 100644 --- a/contents/articles/2017-05_cognitive-vr/index.md +++ b/contents/articles/2017-05_cognitive-vr/index.md @@ -1,8 +1,8 @@ --- -title: cognitiveVR +title: Pupil Labs + cognitiveVR date: Wed May 17 2017 14:10:45 GMT+0200 (CEST) author: Pupil Dev Team -subtitle: 'Pupil Labs Vive Add-On with cognitiveVR' +subtitle: "Check out Pupil Labs HTC Vive Add-on used by cognitiveVR" featured_img: "../../../../media/images/blog/cognitive-vr.jpg" featured_img_thumb: "../../../../media/images/blog/thumb/cognitive-vr.jpg" --- From b525761b1ba82fa8c853831b5143f3ba05512ce8 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Thu, 18 May 2017 12:23:05 +0700 Subject: [PATCH 22/23] update submodule ref and change dates for blog posts --- contents/articles/2017-05_cognitive-vr/index.md | 2 +- contents/articles/2017-05_pupil-v0910-release-notes/index.md | 2 +- contents/media | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/contents/articles/2017-05_cognitive-vr/index.md b/contents/articles/2017-05_cognitive-vr/index.md index 91115aae..4ef7e4a6 100644 --- a/contents/articles/2017-05_cognitive-vr/index.md +++ b/contents/articles/2017-05_cognitive-vr/index.md @@ -1,6 +1,6 @@ --- title: Pupil Labs + cognitiveVR -date: Wed May 17 2017 14:10:45 GMT+0200 (CEST) +date: Thu May 18 2017 14:10:45 GMT+0200 (CEST) author: Pupil Dev Team subtitle: "Check out Pupil Labs HTC Vive Add-on used by cognitiveVR" featured_img: "../../../../media/images/blog/cognitive-vr.jpg" diff --git a/contents/articles/2017-05_pupil-v0910-release-notes/index.md b/contents/articles/2017-05_pupil-v0910-release-notes/index.md index 1429fee1..b6a511ec 100644 --- a/contents/articles/2017-05_pupil-v0910-release-notes/index.md +++ b/contents/articles/2017-05_pupil-v0910-release-notes/index.md @@ -1,6 +1,6 @@ --- title: Pupil Capture, Player, and Service Release v0.9.10 -date: Wed May 18 2017 17:34:00 GMT+0700 (ICT) +date: Tue May 16 2017 17:34:00 GMT+0700 (ICT) author: Pupil Dev Team subtitle: "We are pleased to announce the latest release of the Pupil Platform v0.9.10..." tag: {"caption":"v0.9.10","icon":"local_offer"} diff --git a/contents/media b/contents/media index 28f5e670..0c007c28 160000 --- a/contents/media +++ b/contents/media @@ -1 +1 @@ -Subproject commit 28f5e670108ace5f45b726525ce3fc67f9ff0806 +Subproject commit 0c007c281646841f721ebb5052941f630e8b57fa From ff25a1c5ae5d883db33cf0f6a3ba6a6a3bc214f0 Mon Sep 17 00:00:00 2001 From: Will Patera Date: Thu, 18 May 2017 12:28:43 +0700 Subject: [PATCH 23/23] edit cognitiveVR copy text --- contents/articles/2017-05_cognitive-vr/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/contents/articles/2017-05_cognitive-vr/index.md b/contents/articles/2017-05_cognitive-vr/index.md index 4ef7e4a6..d2a61933 100644 --- a/contents/articles/2017-05_cognitive-vr/index.md +++ b/contents/articles/2017-05_cognitive-vr/index.md @@ -7,6 +7,8 @@ featured_img: "../../../../media/images/blog/cognitive-vr.jpg" featured_img_thumb: "../../../../media/images/blog/thumb/cognitive-vr.jpg" --- +We are excited to announce that cognitiveVR has released support for Pupil Labs eye tracking add-ons! + [cognitiveVR](http://cognitivevr.co/) is a powerful analytics platform for virtual reality to give content creators the ability to make better VR. Helping companies extract value from VR experiences by providing the tools to record, measure and analyze.
@@ -15,6 +17,6 @@ featured_img_thumb: "../../../../media/images/blog/thumb/cognitive-vr.jpg"
Pupil Labs Vive Add-On with cognitiveVR
-This demo showcases [Pupil Labs Vive Add-On](https://pupil-labs.com/store/#vr-ar) tracking gaze movement in a VR environment running cognitiveVR in Unity. Software development kit for [Unity SDK](https://docs.cognitivevr.io/unity/get-started/) have been released by cognitiveVR for users to integrate their Unity projects with [HTC Vive](https://www.vive.com) and [Pupil Labs Vive Add-On](https://pupil-labs.com/store/#vr-ar). Along with multiple [VR SDKs](https://docs.cognitivevr.io/unity/hmd-specific-info/#multiple-sdks) in Unity to work with. +This cognitiveVR demo showcases [Pupil Labs HTC Vive Add-On](https://pupil-labs.com/store/#vr-ar) tracking gaze movement of a participant in a VR environment. The cognitiveVR team released a development kit for [Unity SDK](https://docs.cognitivevr.io/unity/get-started/) enabling you to easily integrate Pupil Labs eye tracking into your Unity scene. You can use the cognitiveVR Pupil SDK in parallel with Steam VR. For more information on how to use Pupil Labs eye tracking with cognitiveVR, head over to [cognitiveVR documentation](https://docs.cognitivevr.io/unity/hmd-specific-info/#pupil-labs-vive-add-on). \ No newline at end of file