Skip to content

Commit 9c385b9

Browse files
authored
Merge pull request #96 from justwriteclick/simpler-landing
Simpler landing
2 parents 371652d + 548e4a9 commit 9c385b9

5 files changed

Lines changed: 13 additions & 14 deletions

File tree

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Site wide configuration
22

3-
title: Write, Review, Test, Merge, Build, Deploy, Repeat. <br> Let's Treat Docs Like Code
3+
title: Let's Treat Docs Like Code
44
locale: en-US
5-
description: When you want to write more content, create accurate technical docs, iterate with collaborators, test drafts, merge, build, and deploy docs.
5+
description: Read stories, learn through adventures, share with others.
66
logo: /images/treat-docs-like-code.png
77
#url: http://127.0.0.1:4000
88
url: https://www.docslikecode.com

_posts/articles/2018-06-05-cloudify-dont-stop-dreaming.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ So this is the story…
2626
The first task I received when I arrived at the company seemed simple. “Our sidebar table of contents (TOC) has a long list of top-level categories that are not well organized and confusing to our customers.” Well, sounds easy enough. To get started, we’ll make a hierarchy that simplifies those categories into 5 groups that basically match 5 types of users. Once we get that quick win we can then look at the content in the categories and combine information in the different topics to condense the content into fewer topics. I figured I could have that done in a week with a lot of buffer. My boss said, “Great!”
2727

2828
![Old Cloudify docs](../../images/cloudify/old-cloudify-docs.png)
29+
2930
([Old Cloudify Docs Site](https://docs.cloudify.co/4.2.0))
3031

3132
Now, here are the pitfalls that I met along the way:
@@ -47,6 +48,7 @@ After a few weeks of struggling to learn where everything was and getting nowher
4748
Then I looked for a Hugo theme that looked good for documentation and found DocDock. It had a lot of the things that I wanted, including TOC based on directory structure , a main landing page, expanding blocks, single-sourced excerpts, and greatly improved search functionality. When I added the theme to my repo, the site built right away. Great, finally something that worked smoothly! I showed the result to my boss and we agreed that there was a lot of hope here. I told her that I think we could get a fully-functioning POC in a week. Turned out to be a little optimistic.
4849

4950
![Hugo Docdock theme](../../images/cloudify/hugo-docdock.png)
51+
5052
([DocDock Theme Site](http://docdock.netlify.com/))
5153

5254
Some of the challenges that I faced were:
@@ -72,6 +74,7 @@ Release day arrived. I scheduled it on a Sunday to minimize disruption, of cours
7274
I finally merged the changes from my side-branch into the master branch and things went pretty smoothly. Some tweaks were required but nothing so bad that I needed to rollback again. Unfortunately, a few more days of struggle with redirections of old URLs using AWS S3 only brought frustration. Then, I found that I could add an alias to each page so that Hugo published HTML files at the old URL locations to redirect to the new URLs. I can safely say that was the final step that brought the project to a successful conclusion.
7375

7476
![New Cloudify docs](../../images/cloudify/new-cloudify-docs.png)
77+
7578
([New Cloudify Docs Site](https://docs.cloudify.co/))
7679

7780
## Success at last!
-62.7 KB
Loading

index.html

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,21 @@
55
search: false
66
---
77

8-
<img src="images/docs-like-code-book.jpg" alt="Docs Like Code Book" align="right" hspace="20" height="100" width="159">
8+
<a href="http://www.lulu.com/spotlight/justwriteclick"><img src="images/docs-like-code-book.jpg" alt="Docs Like Code Book" align="right" hspace="20" height="100" width="159"></a>
99

1010
<h1>About the book</h1>
1111
<p>We've transformed the way teams work together on docs, and we want to talk about the best practices for writing docs using development tools and techniques.</p>
12-
<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn btn--light-outline btn--large"><i class='fa fa-book'></i> Buy Now</a></p>
12+
<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn"><i class='fa fa-book'></i> Buy Now</a></p>
1313

14-
15-
{% include sign-up.html %}
16-
17-
18-
<h1>Get the t-shirt!</h1>
14+
<h2>Get the t-shirt!</h2>
1915

2016
<a href="https://just-write-click.myshopify.com/">Now available - Docs Like Code t-shirts</a>!
2117

22-
<a href="https://just-write-click.myshopify.com/"><img src="images/docs-like-code-womens-cut-tshirt.png" alt="Docs Like Code T-shirt" align="center"></a>
18+
<a href="https://just-write-click.myshopify.com/"><img src="images/docs-like-code-womens-cut-tshirt.png" alt="Docs Like Code T-shirt" align="right"></a>
2319

20+
<h2>Articles</h2>
2421
<p>Read more <a href="{{base_url}}/articles/">articles</a> on this site about
2522
using GitHub for documentation. Let's find out the best practices and create a balance point between artisanal craft and automation efficiency.
2623
</p>
24+
25+
{% include sign-up.html %}

tshirt/index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,11 @@
22
layout: page
33
title: Get the Shirt
44
excerpt: "Docs Like Code T-shirt, buy a shirt and wear it with pride!"
5-
image:
6-
path: /images/docs-like-code-womens-cut-tshirt.png
7-
caption: "[Shopify mockup](http://just-write-click.myshopify.com/)"
85
comments: false
96
share: true
107
last_modified_at: Sat May 13 08:39:50 CDT 2017
118
---
129

13-
Get <a href="http://just-write-click.myshopify.com/">t-shirts</a> now!
10+
<a href="https://just-write-click.myshopify.com/"><img src="../../images/docs-like-code-womens-cut-tshirt.png" alt="Docs Like Code T-shirt" align="center"></a>
1411

1512
{% include sign-up.html %}

0 commit comments

Comments
 (0)