Skip to content

Commit 1123ad2

Browse files
authored
Merge pull request #120 from justwriteclick/fix-dep
Update theme; link to Learn section from About page
2 parents d3adb79 + f1af26e commit 1123ad2

10 files changed

Lines changed: 150 additions & 38 deletions

File tree

Gemfile.lock

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
activesupport (5.2.1)
4+
activesupport (5.2.2)
55
concurrent-ruby (~> 1.0, >= 1.0.2)
66
i18n (>= 0.7, < 2)
77
minitest (~> 5.1)
88
tzinfo (~> 1.1)
99
addressable (2.5.2)
1010
public_suffix (>= 2.0.2, < 4.0)
1111
colorator (1.1.0)
12-
concurrent-ruby (1.0.5)
12+
concurrent-ruby (1.1.4)
1313
em-websocket (0.5.1)
1414
eventmachine (>= 0.12.9)
1515
http_parser.rb (~> 0.6.0)
1616
eventmachine (1.2.7)
17-
eventmachine (1.2.7-x64-mingw32)
18-
faraday (0.15.2)
17+
faraday (0.15.4)
1918
multipart-post (>= 1.2, < 3)
20-
ffi (1.9.25)
21-
ffi (1.9.25-x64-mingw32)
19+
ffi (1.10.0)
2220
forwardable-extended (2.6.0)
2321
gemoji (3.0.0)
24-
html-pipeline (2.8.4)
22+
html-pipeline (2.10.0)
2523
activesupport (>= 2)
2624
nokogiri (>= 1.4)
2725
http_parser.rb (0.6.0)
2826
i18n (0.9.5)
2927
concurrent-ruby (~> 1.0)
30-
jekyll (3.8.3)
28+
jekyll (3.8.5)
3129
addressable (~> 2.4)
3230
colorator (~> 1.0)
3331
em-websocket (~> 0.5)
@@ -53,7 +51,7 @@ GEM
5351
jekyll (~> 3.3)
5452
jekyll-sitemap (1.2.0)
5553
jekyll (~> 3.3)
56-
jekyll-theme-so-simple (3.1.1)
54+
jekyll-theme-so-simple (3.1.2)
5755
jekyll (~> 3.6)
5856
jekyll-data (~> 1.0)
5957
jekyll-feed (~> 0.9.2)
@@ -62,38 +60,36 @@ GEM
6260
jekyll-seo-tag (~> 2.4)
6361
jekyll-sitemap (~> 1.1)
6462
jemoji (~> 0.8)
65-
jekyll-watch (2.0.0)
63+
jekyll-watch (2.1.2)
6664
listen (~> 3.0)
67-
jemoji (0.10.1)
65+
jemoji (0.10.2)
6866
gemoji (~> 3.0)
6967
html-pipeline (~> 2.2)
7068
jekyll (~> 3.0)
7169
kramdown (1.17.0)
72-
liquid (4.0.0)
70+
liquid (4.0.1)
7371
listen (3.1.5)
7472
rb-fsevent (~> 0.9, >= 0.9.4)
7573
rb-inotify (~> 0.9, >= 0.9.7)
7674
ruby_dep (~> 1.2)
7775
mercenary (0.3.6)
78-
mini_portile2 (2.3.0)
76+
mini_portile2 (2.4.0)
7977
minitest (5.11.3)
8078
multipart-post (2.0.0)
81-
nokogiri (1.8.4)
82-
mini_portile2 (~> 2.3.0)
83-
nokogiri (1.8.4-x64-mingw32)
84-
mini_portile2 (~> 2.3.0)
85-
octokit (4.11.0)
79+
nokogiri (1.10.1)
80+
mini_portile2 (~> 2.4.0)
81+
octokit (4.13.0)
8682
sawyer (~> 0.8.0, >= 0.5.3)
87-
pathutil (0.16.1)
83+
pathutil (0.16.2)
8884
forwardable-extended (~> 2.6)
8985
public_suffix (3.0.3)
9086
rb-fsevent (0.10.3)
91-
rb-inotify (0.9.10)
92-
ffi (>= 0.5.0, < 2)
93-
rouge (3.2.1)
87+
rb-inotify (0.10.0)
88+
ffi (~> 1.0)
89+
rouge (3.3.0)
9490
ruby_dep (1.5.0)
95-
safe_yaml (1.0.4)
96-
sass (3.5.7)
91+
safe_yaml (1.0.5)
92+
sass (3.7.3)
9793
sass-listen (~> 4.0.0)
9894
sass-listen (4.0.0)
9995
rb-fsevent (~> 0.9, >= 0.9.4)
@@ -107,7 +103,6 @@ GEM
107103

108104
PLATFORMS
109105
ruby
110-
x64-mingw32
111106

112107
DEPENDENCIES
113108
jekyll-theme-so-simple

_posts/articles/2018-10-12-platformos-1of4.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: "Building Our Documentation Site on Platform OS — Part 1: Information Architecture"
4-
excerpt: This article series describes our process for building the Platform OS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
3+
title: "Building Our Documentation Site on PlatformOS — Part 1: Information Architecture"
4+
excerpt: This article series describes our process for building the PlatformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
55
last_modified_at: Fri Oct 12 21:01:44 CDT 2018
66
categories: articles
77
author: diana_lakatos
88
tags: [developer documentation, Design Thinking, Information Architecture, docs, documentation, UX]
99
image:
1010
path: /images/platformos/platformos_part1/part1_cover.jpg
11-
caption: "[Courtesy Platform OS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
11+
caption: "[Courtesy PlatformOS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
1212
comments: false
1313
share: true
1414
---
1515

16-
This article series describes our process of building our [documentation site](https://documentation.platform-os.com/) for [Platform OS](https://www.platform-os.com/), with in-depth insights into our approach, decisions, and plans. We have planned four parts for this series, each describing a unique aspect of our journey:
16+
This article series describes our process of building our [documentation site](https://documentation.platform-os.com/) for [PlatformOS](https://www.platform-os.com/), with in-depth insights into our approach, decisions, and plans. We have planned four parts for this series, each describing a unique aspect of our journey:
1717

1818
* Part 1: **Information Architecture**
1919
In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
@@ -24,7 +24,7 @@ This article series describes our process of building our [documentation site](h
2424
* Part 4: **Implementation**
2525
In this part, we take a look under the hood, and discuss the technologies we used, how we built our auto-generated API Reference, and how we pull content and related information from Github. We also share our future plans with you.
2626

27-
All these articles together will show you a complete framework for building a documentation site on Platform OS.
27+
All these articles together will show you a complete framework for building a documentation site on PlatformOS.
2828

2929
We are continuously working on our documentation, but decided to make it public early on to get valuable feedback and show you the whole process, so please expect the documentation site to change and evolve while you learn more about it through these articles. At the time of the publication of this article, our documentation site is in alpha.
3030

@@ -109,6 +109,6 @@ This concluded our Information Architecture phase. We have discovered and organi
109109

110110
_We involved [UX Strategist Katalin Nagygyörgy](https://www.linkedin.com/in/nagygyorgykatalin/) in our process from the start. Through our collaboration, we could extract and collect all the necessary information using tried and true research methodologies and UX best practices._
111111

112-
_This article was originally written for the [Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)._
112+
_This article was originally written for the [PlatformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-1-information-architecture)._
113113

114114
{% include sign-up.html %}

_posts/articles/2018-11-01-platformos-2of4.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: "Building Our Documentation Site on Platform OS — Part 2: Content Production and Layouts"
3+
title: "Building Our Documentation Site on PlatformOS — Part 2: Content Production and Layouts"
44
excerpt: Welcome to part 2 of our article series where we discuss how content production started, and how we created the layouts and navigation for the site.
55
last_modified_at: Thu Nov 01 22:01:44 CDT 2018
66
categories: articles
77
author: diana_lakatos
88
tags: [developer documentation, Content-First Design, community, style guide, templates, editorial workflow, wireframes, docs, documentation, UX]
99
image:
1010
path: /images/platformos/platformos_part2/part2_cover.jpg
11-
caption: "[Courtesy Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
11+
caption: "[Courtesy PlatformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
1212
comments: false
1313
share: true
1414
---
1515

16-
Welcome to part 2 of our article series where we describe the process of building the [Platform OS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
16+
Welcome to part 2 of our article series where we describe the process of building the [PlatformOS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
1717

1818
Now that you’ve seen how we explored the needs of our audience, outlined the types of content we’d work on, and created a sitemap in part 1, let’s move on to discuss how content production started, and how we created the layouts and navigation for the site.
1919

@@ -136,12 +136,12 @@ _Wireframe for the tutorial topic type_
136136

137137
As you can see from the process so far, we put our focus on audience, content, and UX — leaving visual design for later.
138138

139-
Both the Design Thinking approach, and the Content-First approach we described in this article push visual design to a later stage. At the same time, the branding of Platform OS is still in the making — with the help of the wonderful [Yiying Lu](https://www.linkedin.com/in/yiyinglu/). This means, that by the time our branding is done, we will have a working documentation site tested with real users, continuously improved based on relevant feedback. We believe that this way we could focus on the most important aspects for each phase, and our documentation site will have a solid foundation that the design can enhance. This is why, for now, we went with a very simple, clean design.
139+
Both the Design Thinking approach, and the Content-First approach we described in this article push visual design to a later stage. At the same time, the branding of PlatformOS is still in the making — with the help of the wonderful [Yiying Lu](https://www.linkedin.com/in/yiyinglu/). This means, that by the time our branding is done, we will have a working documentation site tested with real users, continuously improved based on relevant feedback. We believe that this way we could focus on the most important aspects for each phase, and our documentation site will have a solid foundation that the design can enhance. This is why, for now, we went with a very simple, clean design.
140140

141141
We hope you enjoyed learning about how we started content production, how we built our editorial workflow, and how we created wireframes for our documentation site. **Stay tuned to learn more about the community aspects of our docs in part 3 of our series!**
142142

143143
_We involved [UX Strategist Katalin Nagygyörgy](https://www.linkedin.com/in/nagygyorgykatalin/) in our process from the start. Through our collaboration, we could extract and collect all the necessary information using tried and true research methodologies and UX best practices._
144144

145-
_This article was originally written for the [Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)._
145+
_This article was originally written for the [PlatformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
146146

147147
{% include sign-up.html %}

0 commit comments

Comments
 (0)