Skip to content

Commit 58ade11

Browse files
authored
Merge pull request #98 from justwriteclick/index-update
Index update
2 parents 9c385b9 + b0c7a11 commit 58ade11

6 files changed

Lines changed: 40 additions & 19 deletions

_includes/sign-up.html

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
<!-- Begin MailChimp Signup Form -->
22
<link href="//cdn-images.mailchimp.com/embedcode/slim-10_7.css" rel="stylesheet" type="text/css">
33
<style type="text/css">
4-
#mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
5-
/* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
4+
/* #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
5+
Add your own MailChimp form style overrides in your site stylesheet or in this style block.
66
We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
77
</style>
8+
<blockquote>
89
<div id="mc_embed_signup">
910
<form action="//justwriteclick.us1.list-manage.com/subscribe/post?u=3828f8d87d82289b96ff8fd19&amp;id=cc1d483d59" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
1011
<div id="mc_embed_signup_scroll">
11-
<label for="mce-EMAIL">Enter your email address to learn about docs like code together.</label>
12-
<p>You get free lessons plus a free review checklist in a neat PDF file.</p>
12+
<i class='fa fa-envelope-square'></i>
13+
<label for="mce-EMAIL">Enter your email for free lessons plus a review checklist in a neat PDF file.</label>
14+
1315
<input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required>
1416
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
1517
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_3828f8d87d82289b96ff8fd19_cc1d483d59" tabindex="-1" value=""></div>
16-
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="btn"></div>
18+
<div class="clear"><input type="submit" value="Join now" name="subscribe" id="mc-embedded-subscribe" class="btn btn--inverse"></div>
1719
</div>
1820
</form>
1921
</div>
20-
<!--End mc_embed_signup-->
22+
</blockquote>
23+
<!--End mc_embed_signup-->

_posts/articles/2016-12-29-coming-soon-writing-docs-like-code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ comments: true
1212
share: true
1313
---
1414

15-
I'm working hard on a new book with two collaborators, Diane Skwish and Kelly Holcomb, titled "Write Docs Like Code." We're editing and organizing like mad now, working hard to get all our experiences and best practices written down for the world to see. So I ask you, what do you want to know about writing docs like code?
15+
I've been working hard on a new book with two collaborators, Diane Skwish and Kelly Holcomb, titled "Docs Like Code." We're editing and organizing like mad now, working hard to get all our experiences and best practices written down for the world to see. So I ask you, what do you want to know about writing docs like code?
1616

1717
Here are some of the topics:
1818

@@ -27,6 +27,6 @@ Here are some of the topics:
2727
* Tutorials: Get started with docs like code
2828
* What about wikis?
2929

30-
When you treat docs as code, what are your biggest barriers? Your looming concerns? Let me know so we can address these in the book itself. Sign up below to find out when the book is available.
30+
When you treat docs as code, what are your biggest barriers? Your looming concerns? Let me know so we can address these. Sign up below to learn more together.
3131

3232
{% include sign-up.html %}

_posts/articles/2017-06-03-api-docs-with-code.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,5 @@ Each time that the code builds, the `swagger.json` file updates with the most cu
161161
Static site generators are all the rage, and for good reason. Providing a lightweight framework that can be deployed quickly is a huge asset when documenting APIs, especially external-facing documentation. Numerous options are available, but DapperDox felt like the right fit for our needs.
162162

163163
The pain of determining why DapperDox was broken and the additional coding required to fix the problem was worth the effort, and we are poised to integrate this process into the next set of APIs that our team develops.
164+
165+
{% include sign-up.html %}

_posts/articles/2017-06-05-free-open-source-api-doc-tools.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ image:
1212
comments: true
1313
share: true
1414
---
15+
{% include sign-up.html %}
1516

1617
Open source API documentation generators
1718
========================================
@@ -295,3 +296,5 @@ An **Application Programming Interface (API)** is a set of clearly defined metho
295296
- **API providers**: To provide an overview of free and open source tools for companies that want to share, update or customize their API docs or developer portal.
296297
- **Developer portal builders**: To provide an independent review of existing developer portal solutions that developer teams tasked with building developer portals can use as a reference in discussions with their clients, to make it easier to select the one that best fits their needs.
297298
- **Technical writers**: To create a resource that tech writers can use to select the API documentation infrastructure that fits best with their existing authoring workflows.
299+
300+
{% include sign-up.html %}

_posts/articles/2017-09-19-cisco-devnet-pubhub.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,5 @@ Because the system is meant for individual teams to review their own content, th
6767
## Do you have automation? If so, what type or tooling, and where is the automation in the workflow?
6868

6969
Yes, absolutely as that's one of the drivers for the system, is to enable automation and integration into existing CI/CD workflows to keep in sync with code changes. The PubHub system uses Apache Kafka to manage notifications on updates for each repo and then publish them as static files. The automation for publishing is triggered when the team makes a "release" of the repository, indicating that the content is ready for public consumption.
70+
71+
{% include sign-up.html %}

index.html

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
11
---
22
layout: home
3-
title: ""
3+
title: "Docs Like Code"
44
excerpt: "Docs like code means treating docs as artfully and mindfully as code."
55
search: false
66
---
77

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>
8+
{% include sign-up.html %}
9+
10+
<div>
11+
<a href="http://www.lulu.com/spotlight/justwriteclick"><img src="images/docs-like-code-book.jpg" alt="Docs Like Code Book" align="left" hspace="20" vspace="20" height="100" width="159"></a>
12+
13+
<h1>Buy the book</h1>
14+
15+
<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn btn--inverse"><i class='fa fa-book'></i> Buy Now</a></p>
916

10-
<h1>About the book</h1>
11-
<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"><i class='fa fa-book'></i> Buy Now</a></p>
17+
<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. Now in its second edition.</p>
1318

14-
<h2>Get the t-shirt!</h2>
19+
</div>
1520

16-
<a href="https://just-write-click.myshopify.com/">Now available - Docs Like Code t-shirts</a>!
21+
<div style="clear:both">
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="left" hspace="20" vspace="20" height="100" width="159"></a>
1723

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>
24+
<h2>Get the t-shirt</h2>
1925

20-
<h2>Articles</h2>
26+
<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn btn--inverse"><i class='fa fa-shopping-cart'></i> Get Your Size</a></p>
27+
28+
<p>Show what you know, or what you've read. You can spot these at your favorite documentation conferences such as <a href="http://www.writethedocs.org/conf/">Write the Docs</a> and <a href="https://apithedocs.org/">API the Docs</a>.</p>
29+
</div>
30+
31+
<div style="clear:both">
32+
<h2>Read the articles</h2>
2133
<p>Read more <a href="{{base_url}}/articles/">articles</a> on this site about
2234
using GitHub for documentation. Let's find out the best practices and create a balance point between artisanal craft and automation efficiency.
2335
</p>
24-
25-
{% include sign-up.html %}
36+
</div>

0 commit comments

Comments
 (0)