Skip to content

Commit ed82597

Browse files
tomjohttomjoht
committed
fix links
1 parent 6dade28 commit ed82597

File tree

19 files changed

+23
-24
lines changed

19 files changed

+23
-24
lines changed

‎_docs/additional_resources/resources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
This section contains additional exercises and information, such as more activities for calling APIs, or more info about alternative specifications. I also archive topics here that don't seem to fit well anywhere else.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_fifteen.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_fifteen.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/code_tutorials/docapiscode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ last-modified: 2023-05-28
1313
Documenting code poses one of the most challenging tasks for technical writers, especially if the writers don't have an engineering background or familiarity with the code. Even without deeper engineering expertise, you can still document code &mdash; everything from code snippets to full-fledged sample apps. This section explores techniques and strategies for documenting code.
1414

1515
{: .tip}
16-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_seven.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
16+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_eight.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1717

1818
{% include minitoc.html %}

‎_docs/conceptual_topics_in_api_docs/docconceptual.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
While reference topics in APIs generally receive the most attention, the conceptual topics, such as getting started tutorials, information about authorization, rate limiting, status and error codes, quick reference guides, and other topics constitute about half of the documentation. These topics are usually handled by technical writers more than engineers. You can evaluate the quality of API documentation in part by looking to see whether it includes these conceptual topics.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_three.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_seven.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/documenting_api_endpoints/docendpoints.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Reference documentation for API endpoints consists of five general sections: resource descriptions, endpoints and methods, parameters, sample requests, and sample responses and schemas. To document the reference endpoints of an API, provide detailed information for each of these sections.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_three.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_three.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/introduction_to_rest_apis/docapis_introtoapis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ last-modified: 2023-05-28
1313
REST APIs are flourishing in the marketplace, and the web is becoming a mashup of interconnected APIs. REST APIs consist of requests to and responses from a web server. Job prospects are hot for technical writers who can write developer documentation. This course will help you break into API documentation, especially if you complete the many portfolio-building activities.
1414

1515
{: .tip}
16-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_one.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
16+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_one.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1717

1818
{% include minitoc.html %}

‎_docs/metrics_and_measurement/docapis_metrics_and_measurement.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Metrics and measurement addresses ways to measure API documentation quality and how to track your progress on improvement. You can use the quality checklist here to review essential components of documentation and decide how your API docs measure up. The checklist can be a way to investigate, analyze, and interrogate your documentation from another perspective and discover ways to improve it.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_fourteen.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_fourteen.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/native_library_apis/nativelibraryapis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Native library APIs refer to Java, C++, or other programming-specific APIs. In this model, rather than making requests across the web for the information, you download a library of code and integrate it into your project. The library is compiled directly into your application's build (rather than accessed through web protocols as with REST APIs). Although this type of API is less common, I include it here in part to clarify what makes REST APIs so different from native library APIs.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_twelve.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_twelve.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/newsletter.md

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ show_newsletter: never
1414
{% include mailjet_embedded.html %}
1515
{% endif %}
1616

17-
1817
<style>
1918
body.pas-body {
2019
display: none !important;

‎_docs/openapi_spec_and_generated_ref_docs/restapispecifications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
The OpenAPI specification provides a formal way of describing your REST API and includes all the reference sections mentioned in the previous section, Documenting API endpoints. Display frameworks such as Swagger UI can parse the OpenAPI specification and generate interactive documentation that lets users try out endpoints while learning about the API.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_four.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_four.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/processes_and_methodology/docapis_managing_doc_processes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
The process for managing developer portal documentation includes a number of different tasks outside of content development. The role of a DX (developer experience) content strategist plays a key role in defining workflows, standards, user flows, processes, and other aspects of the site. workflows for different types of documentation. In this section, I cover details for how to manage the doc work, including processes for fixing doc bugs versus tackling larger doc projects. I also explain processes for releasing SDKs, managing external contributions, and more.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_thirteen.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_thirteen.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/publishing_api_documentation/publishingapis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
API documentation often follows a docs-as-code workflow, where the tools to author and publish documentation align closely with the same tools developers use to write, manage, build, and deploy code. Docs-as-code involves using lightweight formats such as Markdown, collaborating through Git or other version control, building your doc site with a static site generator, and deploying it through a continuous build model, where the build happens on the server when you push commits to a particular branch.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_ten.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_ten.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/testing_api_docs/testingdocs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Testing your documentation is critical to providing accurate, thorough information. With API and developer docs, due to the high level of complexity and engineering requirements, technical writers might be inclined to simply take information that engineers give them and incorporate it wholesale, without personally testing it. Merely playing an editorial/publishing function, however, can reduce your role to that of an engineer's secretary.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_six.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_six.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/the_writing_process/writing_process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
The writing process refers to the way you write and develop content. There are five main steps to the writing process: planning, information gathering, writing, reviewing, and publishing. Although these aspects of the writing process are general to almost every type of writing, in this section I tailor the information to be specific to writing technical documentation.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_nine.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_nine.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/thriving_in_the_api_doc_space/jobapis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Getting an API documentation job and thriving requires you to demonstrate your technical aptitude through a writing portfolio. The portfolio should include samples of documentation written for developers. One way to build this portfolio is by working on an open-source project. You also need to live in a tech hub where API documentation jobs are available, such as California, Texas, New York, or Virginia. Overall, thriving in the developer documentation space requires you to continually learn a healthy dose of code, which can be challenging.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_eleven.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_eleven.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_docs/using_an_api_like_a_developer/likeadeveloper.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ last-modified: 2023-05-28
1212
Playing a brief role as a developer will help you understand developer needs better, as well as what developers typically look for in API documentation. Developers often use tools such as Postman or curl to make calls. They look at the structure of the response, and they dynamically integrate the needed information into web pages and other applications.
1313

1414
{: .tip}
15-
<a href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_two.pdf"><i class="fas fa-file-pdf"></i> Download a PDF of this section.</a>
15+
<a class="noCrossRef" href="https://s3.us-west-1.wasabisys.com/learnapidoc-outputs/docapis_two.pdf"><i class="fa fa-file-pdf-o"></i> Download a PDF of this section.</a>
1616

1717
{% include minitoc.html %}

‎_includes/markprompt.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!-- Button trigger modal -->
33
<button type="button" class="btn btn-default" data-toggle="modal" data-target="#markPromptChat">
4-
Markprompt Chat
4+
Start AI Chat
55
</button>
66

77
<!-- Modal -->

‎_includes/sidebar.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
<div class="sidebar-inner">
44

55
<div id="search-searchbar"></div>
6-
6+
{% include social_media_icons.html %}
77
<div style="margin-top: 30px; margin-bottom: 30px">
88

99
{% include mailjet_modal.html %}
1010
</div>
1111

12+
1213
{% unless page.sidebar == null %}
1314
<div class="productTitle">{{sidebar.sidebartitle}}</div>
1415

‎_includes/social_media_icons.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
<!-- social_media_icons.html -->
22

3-
<a href="https://feeds.feedburner.com/TomJohnson">
3+
<a class="noCrossRef" href="https://feeds.feedburner.com/TomJohnson">
44
<div class="srssfeed"></div>
55
</a>
6-
<a href="https://twitter.com/tomjohnson">
6+
<a class="noCrossRef" href="https://twitter.com/tomjohnson">
77
<div class="stwitter"></div>
88
</a>
99

10-
<a href="https://itunes.apple.com/us/podcast/id-rather-be-writing-podcast/id277365275">
10+
<a class="noCrossRef" href="https://itunes.apple.com/us/podcast/id-rather-be-writing-podcast/id277365275">
1111
<div class="situnes"></div>
1212
</a>
1313

14-
<a href="https://www.linkedin.com/in/tomjoht">
14+
<a class="noCrossRef" href="https://www.linkedin.com/in/tomjoht">
1515
<div class="slinkedin"></div>
1616
</a>
1717

18-
<a href="https://github.com/tomjoht/">
18+
<a class="noCrossRef" href="https://github.com/tomjoht/">
1919
<div class="sgithub"></div>
2020
</a>
2121

‎_layouts/default.html

+1-2
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@
169169
{% comment %}
170170
{% include sidebar_comics.html %}
171171
{% endcomment %}
172-
{% include social_media_icons.html %}
173172

174173
</div>
175174

@@ -191,7 +190,7 @@ <h1>{{page.title}}</h1>
191190
<div class="amazonBook">
192191
</div>
193192

194-
<p class="surveyBanner" style="font-size: 98%; line-height: 18px"><b>Experiment:</b> Try out the GPT Chat for this site. <br/><br/>{% include markprompt.html %}<br/></p>
193+
<p>{% include markprompt.html %}</p>
195194

196195

197196
{% if page.versions %}{% include versions.html %}{% endif %}

0 commit comments

Comments
 (0)