Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions _includes/sign-up.html
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
<!-- Begin MailChimp Signup Form -->
<link href="//cdn-images.mailchimp.com/embedcode/slim-10_7.css" rel="stylesheet" type="text/css">
<style type="text/css">
#mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
/* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
/* #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
Add your own MailChimp form style overrides in your site stylesheet or in this style block.
We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
</style>
<blockquote>
<div id="mc_embed_signup">
<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>
<div id="mc_embed_signup_scroll">
<label for="mce-EMAIL">Enter your email address to learn about docs like code together.</label>
<p>You get free lessons plus a free review checklist in a neat PDF file.</p>
<i class='fa fa-envelope-square'></i>
<label for="mce-EMAIL">Enter your email for free lessons plus a review checklist in a neat PDF file.</label>

<input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required>
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_3828f8d87d82289b96ff8fd19_cc1d483d59" tabindex="-1" value=""></div>
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="btn"></div>
<div class="clear"><input type="submit" value="Join now" name="subscribe" id="mc-embedded-subscribe" class="btn btn--inverse"></div>
</div>
</form>
</div>
<!--End mc_embed_signup-->
</blockquote>
<!--End mc_embed_signup-->
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ comments: true
share: true
---

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?
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?

Here are some of the topics:

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

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.
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.

{% include sign-up.html %}
2 changes: 2 additions & 0 deletions _posts/articles/2017-06-03-api-docs-with-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,5 @@ Each time that the code builds, the `swagger.json` file updates with the most cu
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.

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.

{% include sign-up.html %}
3 changes: 3 additions & 0 deletions _posts/articles/2017-06-05-free-open-source-api-doc-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ image:
comments: true
share: true
---
{% include sign-up.html %}

Open source API documentation generators
========================================
Expand Down Expand Up @@ -295,3 +296,5 @@ An **Application Programming Interface (API)** is a set of clearly defined metho
- **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.
- **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.
- **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.

{% include sign-up.html %}
2 changes: 2 additions & 0 deletions _posts/articles/2017-09-19-cisco-devnet-pubhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ Because the system is meant for individual teams to review their own content, th
## Do you have automation? If so, what type or tooling, and where is the automation in the workflow?

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.

{% include sign-up.html %}
33 changes: 22 additions & 11 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,36 @@
---
layout: home
title: ""
title: "Docs Like Code"
excerpt: "Docs like code means treating docs as artfully and mindfully as code."
search: false
---

<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>
{% include sign-up.html %}

<div>
<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>

<h1>Buy the book</h1>

<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn btn--inverse"><i class='fa fa-book'></i> Buy Now</a></p>

<h1>About the book</h1>
<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>
<p><a href="http://www.lulu.com/spotlight/justwriteclick" class="btn"><i class='fa fa-book'></i> Buy Now</a></p>
<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>

<h2>Get the t-shirt!</h2>
</div>

<a href="https://just-write-click.myshopify.com/">Now available - Docs Like Code t-shirts</a>!
<div style="clear:both">
<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>

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

<h2>Articles</h2>
<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>

<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>
</div>

<div style="clear:both">
<h2>Read the articles</h2>
<p>Read more <a href="{{base_url}}/articles/">articles</a> on this site about
using GitHub for documentation. Let's find out the best practices and create a balance point between artisanal craft and automation efficiency.
</p>

{% include sign-up.html %}
</div>