Skip to content

Commit 5526401

Browse files
committed
fix links for pdf output
1 parent 21aa5e0 commit 5526401

File tree

62 files changed

+250
-249
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+250
-249
lines changed

_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,4 @@ webmaster_verifications:
119119
google: i1qwK1LFgKEQHUtpm8o7OOOeK9i54NUQwKR4vXRqlFs
120120
bing: 352636FE6BAFC693A6938983FC6A227E
121121

122-
lang: en_US
122+
lang: en_US

_data/glossary.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ swagger:
253253

254254
swagger_codegen:
255255
term: Swagger Codegen
256-
def: "Generates client SDK code for a lot of different platforms (such as Java, JavaScript, Scala, Python, PHP, Ruby, Scala, and more). The client SDK code helps developers integrate your API on a specific platform and provides for more robust implementations that might include more scaling, threading, and other necessary code. In general, SDKs are toolkits for implementing the requests made with an API. Swagger Codegen generates the client SDKs in nearly every programming language. See [Swagger Codegen](https://swagger.io/swagger-codegen/) for more information. See also [SDKs](docapis_sdks.html)."
256+
def: "Generates client SDK code for a lot of different platforms (such as Java, JavaScript, Scala, Python, PHP, Ruby, Scala, and more). The client SDK code helps developers integrate your API on a specific platform and provides for more robust implementations that might include more scaling, threading, and other necessary code. In general, SDKs are toolkits for implementing the requests made with an API. Swagger Codegen generates the client SDKs in nearly every programming language. See [Swagger Codegen](https://swagger.io/swagger-codegen/) for more information. See also [SDKs](https://idratherbewriting.com/learnapidoc/docapis_sdks.html)."
257257

258258
swagger_editor:
259259
term: Swagger Editor

_data/quality_checklist.yml

+16-16
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ relevance:
7272
priority: high
7373

7474
- title: Code samples exist
75-
description: "<a href='docapis_codesamples_bestpractices.html'>Code samples</a> showing sample ways to use the API (or similar tools) are provided. Ideally, the code samples are available in the user's target language. This might mean providing multiple code samples."
75+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_codesamples_bestpractices.html'>Code samples</a> showing sample ways to use the API (or similar tools) are provided. Ideally, the code samples are available in the user's target language. This might mean providing multiple code samples."
7676
priority: high
7777

7878
- title: Support options noted
@@ -93,18 +93,18 @@ relevance:
9393
clarity:
9494

9595
- title: "Product overview page answers \"wh\" questions"
96-
description: "The <a href='docapis_doc_overview.html'>overview</a> explains the big picture and describes the problem that the tool or service addresses. Common who/what/where/why questions are answered here."
96+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> explains the big picture and describes the problem that the tool or service addresses. Common who/what/where/why questions are answered here."
9797
priority: high
9898

9999
- title: Access and authorization explained
100100
description: "Details about how to get access, permissions, and authorization to use the API are provided. For example, this topic might cover how to authorize an API call with API keys."
101101
priority: high
102102

103103
- title: Overview addresses use cases
104-
description: "The <a href='docapis_doc_overview.html'>overview</a> provides a high-level description of the main use cases or business objectives of the product. This allows users to get a sense of what the API is all about."
104+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> provides a high-level description of the main use cases or business objectives of the product. This allows users to get a sense of what the API is all about."
105105

106106
- title: Overview has architectural diagram and explanation
107-
description: "The <a href='docapis_doc_overview.html'>overview</a> has a diagram of the main components and how they interact. This provides users with a glimpse of the whole."
107+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_overview.html'>overview</a> has a diagram of the main components and how they interact. This provides users with a glimpse of the whole."
108108

109109
- title: Overview has index of assets that the product offers
110110
description: "If there's an SDK or developer kit that users can download, the contents of this download are described. This is similar to product instructions that start by identifying all parts that should have arrived in a package."
@@ -113,7 +113,7 @@ clarity:
113113
description: "For larger systems that might have multiple subsystems (e.g., groups of APIs for different scenarios), these subsystems have their own landing pages that resemble the higher-level overview (with use cases, diagrams, getting started links) but scoped to that specific subsystem."
114114

115115
- title: Getting started tutorial exists
116-
description: "A <a href='docapis_doc_getting_started_section.html'>getting started tutorial</a> is provided for users to get started in an end-to-end way with the product, producing a sample output that builds their confidence. This topic might provide info on how to sign up, register, get API keys or permissions, and start using the API. (This topic might link to the authorization topic but is more comprehensive in scope. The purpose of this topic is frictionless onboarding.)"
116+
description: "A <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_getting_started_section.html'>getting started tutorial</a> is provided for users to get started in an end-to-end way with the product, producing a sample output that builds their confidence. This topic might provide info on how to sign up, register, get API keys or permissions, and start using the API. (This topic might link to the authorization topic but is more comprehensive in scope. The purpose of this topic is frictionless onboarding.)"
117117

118118
- title: Sandbox environment available
119119
description: "A sandbox environment is available for users to try out the tool/system/API on their own and get a better understanding of how it works."
@@ -128,10 +128,10 @@ clarity:
128128
description: "Tasks are articulated through a series of specific, usually numbered steps or sections that reduce the complexity of the task. More complex tasks might require more granular and numerous steps or sections so as to reduce the complexity. (This is the primary way that technical writers simplify complexity.)"
129129

130130
- title: Sample app available
131-
description: "In more robust docs, a <a href='docapis_sample_apps.html'>sample app</a> might serve as a reference implementation for users."
131+
description: "In more robust docs, a <a href='https://idratherbewriting.com/learnapidoc/docapis_sample_apps.html'>sample app</a> might serve as a reference implementation for users."
132132

133133
- title: Code sample has inline comments
134-
description: "<a href='docapis_codesamples_bestpractices.html'>Code samples</a> are appropriately commented, either with inline comments, comments that preface or follow the sample, or both. Long code samples with no explanation aren't just dropped in."
134+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_codesamples_bestpractices.html'>Code samples</a> are appropriately commented, either with inline comments, comments that preface or follow the sample, or both. Long code samples with no explanation aren't just dropped in."
135135

136136
- title: Any role-based permissions are noted
137137
description: "If there are different roles and permission levels that correspond to varying capabilities, these roles are noted in all places they apply, such as within the individual API reference. For example, if only admin roles can use a certain endpoint, this is noted in the endpoint's reference and in any places that use the endpoint."
@@ -140,7 +140,7 @@ clarity:
140140
description: "Specific steps for completing tasks are described in detail rather than glossed over in general ways &mdash; unless the task is something the audience is already familiar with. Overall, the documentation strikes a balance between providing enough detail for users to get the job done but not including too much detail that the reader is inundated with extraneous information."
141141

142142
- title: Workflow maps connect topics in larger flows
143-
description: "Larger tasks that span multiple topics have a <a href='/simplifying-complexity/macro-micro.html'>workflow map</a> (or similar mechanism) that connects the topics together."
143+
description: "Larger tasks that span multiple topics have a <a href='https://idratherbewriting.com/learnapidoc/simplifying-complexity/macro-micro.html'>workflow map</a> (or similar mechanism) that connects the topics together."
144144

145145
- title: Visuals aid in areas of confusion
146146
description: "In places that are particularly confusing, appropriate visuals or additional examples have been added to reduce confusion."
@@ -163,33 +163,33 @@ clarity:
163163
completeness:
164164

165165
- title: Reference docs follow industry standards
166-
description: "For native library APIs (or other API types), reference docs (auto-generated from source code comments) are available. This might mean <a href='nativelibraryapis_exploring_javadoc_output.html'>Javadoc</a>, <a href='nativelibraryapis_doxygen.html'>Doxygen</a>, <a href='pubapis_openapi_intro.html'>OpenAPI</a> outputs like <a href='pubapis_swagger.html'>Swagger</a> or other reference docs specific to the library. The reference docs should be populated and generally follow tagging standards."
166+
description: "For native library APIs (or other API types), reference docs (auto-generated from source code comments) are available. This might mean <a href='https://idratherbewriting.com/learnapidoc/nativelibraryapis_exploring_javadoc_output.html'>Javadoc</a>, <a href='https://idratherbewriting.com/learnapidoc/nativelibraryapis_doxygen.html'>Doxygen</a>, <a href='https://idratherbewriting.com/learnapidoc/pubapis_openapi_intro.html'>OpenAPI</a> outputs like <a href='https://idratherbewriting.com/learnapidoc/pubapis_swagger.html'>Swagger</a> or other reference docs specific to the library. The reference docs should be populated and generally follow tagging standards."
167167
priority: high
168168

169169
- title: Parameter docs have complete info
170-
description: "<a href='docapis_doc_parameters.html'>Parameter documentation</a> typically includes a description, data type, min/max values, sample values, and optional/required usage."
170+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_doc_parameters.html'>Parameter documentation</a> typically includes a description, data type, min/max values, sample values, and optional/required usage."
171171
priority: high
172172

173173
- title: Reference content has consistent structure
174-
description: "Reference material such as APIs follow a <a href='docapis_api_reference_tutorial_overview.html'>common structure within each topic</a>, mostly following a request-response type structure. Typical sections include descriptions, parameters, sample requests or usage, and sample responses."
174+
description: "Reference material such as APIs follow a <a href='https://idratherbewriting.com/learnapidoc/docapis_api_reference_tutorial_overview.html'>common structure within each topic</a>, mostly following a request-response type structure. Typical sections include descriptions, parameters, sample requests or usage, and sample responses."
175175

176176
- title: Error messages are documented
177-
description: "<a href='docapis_doc_status_codes.html'>Error messages</a> that users can encounter are documented and discoverable through search. This supports the <a href='docapiscode_research_on_documenting_code.html#systematic_vs_opportunistic'>opportunistic/experiential user behavior</a>."
177+
description: "<a href='https://idratherbewriting.com/learnapidoc/docapis_doc_status_codes.html'>Error messages</a> that users can encounter are documented and discoverable through search. This supports the <a href='https://idratherbewriting.com/learnapidoc/docapiscode_research_on_documenting_code.html#systematic_vs_opportunistic'>opportunistic/experiential user behavior</a>."
178178

179179
- title: Responses includes both sample and schema (REST APIs)
180-
description: "The <a href='docapis_doc_sample_responses_and_schema.html'>response documentation</a> for REST APIs provides both a sample response and schema. The response provides an example of what might be returned, while the schema defines all possible elements that might be returned and describes attributes such as data types and whether the elements are required or optional in the response."
180+
description: "The <a href='https://idratherbewriting.com/learnapidoc/docapis_doc_sample_responses_and_schema.html'>response documentation</a> for REST APIs provides both a sample response and schema. The response provides an example of what might be returned, while the schema defines all possible elements that might be returned and describes attributes such as data types and whether the elements are required or optional in the response."
181181

182182
- title: Troubleshooting section exists
183183
description: "The documentation has a troubleshooting section (either standalone or included within the section/topic it relates to) that provides information on how to solve common problems. The troubleshooting information indicates where things might go wrong and how to fix them. In other words, the documentation doesn't just describe the happy path."
184184

185185
- title: Limitations/thresholds documented
186-
description: "If there are <a href='docapis_rate_limiting_and_thresholds.html'>limitations and thresholds</a> (for example, max number of API calls, max file sizes, max string lengths, max/min parameter values, max server load), these limitations are called out in the docs."
186+
description: "If there are <a href='https://idratherbewriting.com/learnapidoc/docapis_rate_limiting_and_thresholds.html'>limitations and thresholds</a> (for example, max number of API calls, max file sizes, max string lengths, max/min parameter values, max server load), these limitations are called out in the docs."
187187

188188
- title: Locale limitations noted
189189
description: "If a feature is available only in certain contexts (locales, languages, platforms, roles, versions), that information is noted clearly in the feature. For example, an API that is only available for enterprise versions might have a label that says \"Enterprise Version Only,\" or if only available for a particular platform, might say \"Linux Only\" or the equivalent."
190190

191191
- title: Unhappy paths are documented
192-
description: "If there are pitfalls or other traps, gaps, and gotchas to avoid, these are noted in the documentation rather than hidden from the user. A section called <a href='/2010/12/16/known-limitations/'>Known Limitations</a> often contains this information. The documentation doesn't lie or mislead the user but rather is <a href='/2017/07/13/transparency-in-documentation/'>transparent, honest, and helpful</a> even if it means exposing the product's warts and revealing problems users will like encounter."
192+
description: "If there are pitfalls or other traps, gaps, and gotchas to avoid, these are noted in the documentation rather than hidden from the user. A section called <a href='https://idratherbewriting.com/learnapidoc/2010/12/16/known-limitations/'>Known Limitations</a> often contains this information. The documentation doesn't lie or mislead the user but rather is <a href='https://idratherbewriting.com/learnapidoc/2017/07/13/transparency-in-documentation/'>transparent, honest, and helpful</a> even if it means exposing the product's warts and revealing problems users will like encounter."
193193

194194
readability:
195195

@@ -220,7 +220,7 @@ readability:
220220
description: "Each topic usually has a <a href='https://idratherbewriting.com/2018/09/15/pages-at-a-glance-feature/#enforcing-best-practices-with-structure'>short summary below the title</a> that encapsulates the main purpose of the topic. This helps users get a sense of the topic at a glance."
221221

222222
- title: Glossary exists
223-
description: "Unfamiliar words and jargon are defined in a <a href='docapis_glossary_section.html'>glossary</a>. At times, the glossary terms are linked to their glossary definitions."
223+
description: "Unfamiliar words and jargon are defined in a <a href='https://idratherbewriting.com/learnapidoc/docapis_glossary_section.html'>glossary</a>. At times, the glossary terms are linked to their glossary definitions."
224224

225225
- title: Glossary entries match the actual terms used in the content
226226
description: "Glossary terms (as defined in the glossary) are actually used consistently across the documentation. For example, one doc set doesn't use a certain term while another uses a synonym of the term, with the admin UI using yet another term. If the glossary lists a term for a particular concept, the documentation content consistently uses that term."

_docs/additional_resources/denver_workshop_recordings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ These videos are from an API documentation workshop that I gave in Denver, Color
2020

2121
{% if site.format == "web" %}
2222

23-
{% include note.html content="For the most recent workshop recording, see the [Video recordings of API doc workshops](docapis_course_videos.html)." %}
23+
{% include note.html content="For the most recent workshop recording, see the [Video recordings of API doc workshops](https://idratherbewriting.com/learnapidoc/docapis_course_videos.html)." %}
2424

2525
### Part I of III
2626

_docs/additional_resources/docapis_aerisweather_example.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ In earlier tutorials, you integrated information from the [OpenWeatherMap API](h
2626

2727
## 1. Get the API keys
2828

29-
See the [Getting Started](http://www.aerisweather.com/support/docs/api/getting-started/) page for information on how to register and get API keys. (Get the free version of the keys available to development projects.) You will need both the ID and secret to make API calls. See [Get the Aeris Weather API secret and ID](docapis_get_auth_keys.html#aeris_weather_apikey) for more detail.
29+
See the [Getting Started](http://www.aerisweather.com/support/docs/api/getting-started/) page for information on how to register and get API keys. (Get the free version of the keys available to development projects.) You will need both the ID and secret to make API calls. See [Get the Aeris Weather API secret and ID](https://idratherbewriting.com/learnapidoc/docapis_get_auth_keys.html#aeris_weather_apikey) for more detail.
3030

3131
## 2. Construct the request
3232

0 commit comments

Comments
 (0)