Skip to content

Commit b99cfbe

Browse files
authored
Merge pull request #178 from justwriteclick/ag-linkfix
Fixes links that moved
2 parents 633a351 + d4497d0 commit b99cfbe

8 files changed

Lines changed: 19 additions & 19 deletions

_posts/articles/2017-11-12-rackspace-case-study.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ At the same conference, [Rachel Whitton’s talk Delivering High-Velocity Docs t
103103

104104
Finally, another great resource is Anne Gentle’s [Docs like Code project](https://docslikecode.com/) that aims to share information and capture best practices for creating documentation collaboratively using code systems.
105105

106-
Are you treating docs like code, or thinking about transforming your documentation processes? We’d love to hear your thoughts and experiences. If you have questions or want to know more about contributing to Rackspace documentation, see our [Contributor Guidelines](https://rackerlabs.github.io/docs-rackspace/contributor-collateral/index.html) or e-mail us at devdoc@rackspace.com.
106+
Are you treating docs like code, or thinking about transforming your documentation processes? We’d love to hear your thoughts and experiences. If you have questions or want to know more about contributing to Rackspace documentation, see our [Quickstart](https://docs.rackspace.com/docs/style-guide/quickstart) or e-mail us at devdoc@rackspace.com.
107107

108108
Originally published November 11, 2016, on the [Rackspace Blog](https://blog.rackspace.com/transforming-developer-and-support-documentation-with-docs-like-code).
109109

_posts/articles/2018-02-12-change-case-study.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ comments: false
1313
share: true
1414
---
1515

16-
**Originally published in the [Documenting APIs: A Guide for Technical Writers on Tom Johnson's site, I'd Rather Be Writing](https://idratherbewriting.com/learnapidoc/pubapis_switching_to_docs_as_code.html). Thanks, Tom, for sharing your story in detail for others to learn.**
16+
**Originally published in the [Documenting APIs: A Guide for Technical Writers on Tom Johnson's site, I'd Rather Be Writing](https://idratherbewriting.com/learnapidoc/pubapis_docs_as_code.html). Thanks, Tom, for sharing your story in detail for others to learn.**
1717

1818
{: .tip}
1919
For an overview of the docs-as-code approach, see [Docs-as-code tools](https://idratherbewriting.com/learnapidoc/pubapis_docs_as_code.html). In this article, I describe the challenges we faced in implementing a docs-as-code approach within a tech writing group at a large company.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ author: ben_mansheim
88
tags: [cicd, circleci, cloudify, Docker, docs, Hugo, Go]
99
image:
1010
path: /images/cloudify/docs-as-code-blog-banner.png
11-
caption: "[Courtesy Cloudify blog](https://cloudify.co/2018/06/05/docs-as-code-dont-stop-dreaming)"
11+
caption: "[Courtesy Cloudify blog](https://cloudify.co/blog/docs-as-code-dont-stop-dreaming/)"
1212
comments: false
1313
share: true
1414
---

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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 platformOS 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/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
1212
comments: false
1313
share: true
1414
---
@@ -89,7 +89,7 @@ Based on the Content Inventory and the results of the Card Sorting sessions, we
8989

9090
_Sample page from our sitemap_
9191

92-
We have already changed some parts of our sitemap based on new information we gathered and business decisions we made. For example, we are now planning to build a separate community site, instead of having a community section on our documentation site. We decided to link to content on [platform-os.com](https://www.platform-os.com/blog/post/blog/platform-os-blog-module) (like the blog, terms & conditions, etc.) in the beginning to focus on other parts of the site, and reevaluate these sections later. We believe that both product and content development can benefit from a process that allows for such flexibility.
92+
We have already changed some parts of our sitemap based on new information we gathered and business decisions we made. For example, we are now planning to build a separate community site, instead of having a community section on our documentation site. We decided to link to content on [platform-os.com](https://www.platform-os.com/blog/post/platform-os-blog-module) (like the blog, terms & conditions, etc.) in the beginning to focus on other parts of the site, and reevaluate these sections later. We believe that both product and content development can benefit from a process that allows for such flexibility.
9393

9494
### Persona-based content prioritization
9595

@@ -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 [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-1-information-architecture)._
112+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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 platformOS 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/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
1212
comments: false
1313
share: true
1414
---
@@ -142,6 +142,6 @@ We hope you enjoyed learning about how we started content production, how we bui
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 [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
145+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
146146

147147
{% include sign-up.html %}

_posts/articles/2018-11-25-platformos-3of4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ author: diana_lakatos
88
tags: [developer documentation, contributor experience, community, style guide, templates, editorial workflow, docs, documentation]
99
image:
1010
path: /images/platformos/platformos_part3/part3_cover.jpg
11-
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)"
11+
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-3-community)"
1212
comments: false
1313
share: true
1414
---
@@ -112,6 +112,6 @@ Now that you’ve seen how we discovered the needs of our target audience, plann
112112

113113
_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._
114114

115-
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)._
115+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-3-community)._
116116

117117
{% include sign-up.html %}

_posts/articles/2020-02-26-platformos-4of4.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ author: diana_lakatos
88
tags: [developer documentation, editorial workflow, API documentation, docs, documentation, contribution, testing, QA, performance]
99
image:
1010
path: /images/platformos/platformos_part4/part4_cover.jpg
11-
caption: "[Courtesy platformOS Blog](https://www.platformos.com/blog/post/blog/building-our-documentation-site-on-platformos-part-4-implementation)"
11+
caption: "[Courtesy platformOS Blog](https://www.platformos.com/blog/post/building-our-documentation-site-on-platformos-part-4-implementation)"
1212
comments: false
1313
share: true
1414
---
1515

16-
In this article series we describe the process of building our [award-winning](https://www.platformos.com/blog/post/blog/platformos-developer-portal-wins-uk-technical-communication-award) developer documentation site from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
16+
In this article series we describe the process of building our [award-winning](https://www.platformos.com/blog/post/platformos-developer-portal-wins-uk-technical-communication-award) developer documentation site from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
1717

1818
* [Part 1: Information Architecture](/articles/platformos-1of4)
1919
* [Part 2: Content Production and Layouts](/articles/platformos-2of4)
@@ -132,14 +132,14 @@ In the near future, we are planning to implement **performance testing with real
132132

133133
If you’d be interested in learning more about our process and tools, check out our article series on QA and testing:
134134

135-
* [QA and Testing Best Practices — Part 1: Our QA Process](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-1-our-qa-process)
136-
* [QA and Testing Best Practices — Part 2: Tips and Tricks](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-2-tips-and-tricks)
137-
* [QA and Testing Best Practices — Part 3: Speeding Up Development and Troubleshooting](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-3-speeding-up-development-and-troubleshooting)
138-
* [QA and Testing Best Practices — Part 4: Performance Testing](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-4-performance-testing)
135+
* [QA and Testing Best Practices — Part 1: Our QA Process](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-1-our-qa-process)
136+
* [QA and Testing Best Practices — Part 2: Tips and Tricks](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-2-tips-and-tricks)
137+
* [QA and Testing Best Practices — Part 3: Speeding Up Development and Troubleshooting](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-3-speeding-up-development-and-troubleshooting)
138+
* [QA and Testing Best Practices — Part 4: Performance Testing](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-4-performance-testing)
139139

140140
## Performance
141141

142-
If you read our article about [Code Quality and Performance Best Practices for Your platformOS Site](https://www.platformos.com/blog/post/blog/code-quality-and-performance-best-practices-for-your-platformos-site), you know how good performance can help you keep visitors on your site, provide the best user experience, and rank high in search results. Our documentation is a high-performance site with a Google PageSpeed Insights score of 100 for both Mobile and Desktop, so we thought it could be helpful to dive a bit deeper into what tools we use and how we achieved this amazing performance.
142+
If you read our article about [Code Quality and Performance Best Practices for Your platformOS Site](https://www.platformos.com/blog/post/code-quality-and-performance-best-practices-for-your-platformos-site), you know how good performance can help you keep visitors on your site, provide the best user experience, and rank high in search results. Our documentation is a high-performance site with a Google PageSpeed Insights score of 100 for both Mobile and Desktop, so we thought it could be helpful to dive a bit deeper into what tools we use and how we achieved this amazing performance.
143143

144144
### Measure early, measure often
145145

@@ -256,7 +256,7 @@ We collect user feedback through Slack channels, the feedback block, user resear
256256

257257
We’ve come a long way but there’s still a lot we can improve. Stay tuned, because we will write more articles to support you on your journey with platformOS.
258258

259-
_This article was co-authored by Pawel Kowalski, Front-End Developer and Performance Advocate at platformOS, and 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)._
259+
_This article was co-authored by Pawel Kowalski, Front-End Developer and Performance Advocate at platformOS, and was originally written for the [PlatformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
260260

261261
{% include sign-up.html %}
262262

_posts/articles/2021-02-14-setting-up-techdocs-on-backstage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ You will also see the content in the S3 bucket.
214214

215215
## Recap and summary
216216

217-
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally. We took a look at the cloud storage option with some screenshots showing S3. To learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/TechDocs/TechDocs-overview](https://backstage.io/docs/features/TechDocs/TechDocs-overview) offers a great overview.
217+
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally. We took a look at the cloud storage option with some screenshots showing S3. To learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/techdocs/techdocs-overview](https://backstage.io/docs/features/techdocs/techdocs-overview) offers a great overview.
218218

219219
You can also read about the gains the team at Spotify has seen since using TechDocs for all their documentation in [Ten tips for maintaining a long-term relationship with docs like code](https://www.docslikecode.com/articles/ten-tips-maintaining-long-term-docs-like-code/). TechDocs has a really nice [project board in GitHub,](https://github.com/orgs/backstage/projects/1#card-54927264) so if you're interested in working on it yourself, take a look.
220220

0 commit comments

Comments
 (0)