+ diff --git a/_posts/articles/2016-12-29-coming-soon-writing-docs-like-code.md b/_posts/articles/2016-12-29-coming-soon-writing-docs-like-code.md index 5304dcd4..7377dc57 100644 --- a/_posts/articles/2016-12-29-coming-soon-writing-docs-like-code.md +++ b/_posts/articles/2016-12-29-coming-soon-writing-docs-like-code.md @@ -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: @@ -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 %} diff --git a/_posts/articles/2017-06-03-api-docs-with-code.md b/_posts/articles/2017-06-03-api-docs-with-code.md index 1cbda0e8..8f0598d8 100644 --- a/_posts/articles/2017-06-03-api-docs-with-code.md +++ b/_posts/articles/2017-06-03-api-docs-with-code.md @@ -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 %} diff --git a/_posts/articles/2017-06-05-free-open-source-api-doc-tools.md b/_posts/articles/2017-06-05-free-open-source-api-doc-tools.md index ad2e6b86..c22141c9 100644 --- a/_posts/articles/2017-06-05-free-open-source-api-doc-tools.md +++ b/_posts/articles/2017-06-05-free-open-source-api-doc-tools.md @@ -12,6 +12,7 @@ image: comments: true share: true --- +{% include sign-up.html %} Open source API documentation generators ======================================== @@ -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 %} diff --git a/_posts/articles/2017-09-19-cisco-devnet-pubhub.md b/_posts/articles/2017-09-19-cisco-devnet-pubhub.md index e7b8faed..da27b14d 100644 --- a/_posts/articles/2017-09-19-cisco-devnet-pubhub.md +++ b/_posts/articles/2017-09-19-cisco-devnet-pubhub.md @@ -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 %} diff --git a/index.html b/index.html index bea0c6d5..d8d22fbb 100644 --- a/index.html +++ b/index.html @@ -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 --- -- \ No newline at end of file +
+{% include sign-up.html %}
+
+
+
+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.
- +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.
-
-
+Show what you know, or what you've read. You can spot these at your favorite documentation conferences such as Write the Docs and API the Docs.
+Read more articles 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.
- -{% include sign-up.html %} +