Skip to content

Commit 706bc26

Browse files
authored
[chore] Fix link fragments (#293)
1 parent e1cfca7 commit 706bc26

File tree

11 files changed

+122
-119
lines changed

11 files changed

+122
-119
lines changed

.markdown-link-check.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
{
44
"pattern": "^http://localhost"
55
},
6-
{
7-
"pattern": "^#"
8-
},
96
{
107
"pattern": "^https://(www|docs).tremor.rs"
118
},

analyses/0008-backstage/backstage-analysis.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ tags: backstage
44
created: 2023-09-01
55
modified: 2023-11-28
66
author: Dave Welsch (@dwelsch-esi)
7+
cSpell:ignore: clotributor dwelsch Welsch runbooks WCAG
78
---
89

910
# Introduction
@@ -95,7 +96,7 @@ to their area of concern:
9596

9697
- [Project documentation][proj-doc]
9798
- [Contributor documentation][contributor-doc]
98-
- [Website and documentation infrrastructure][website]
99+
- [Website and documentation infrastructure][website]
99100

100101
Examples of CNCF documentation that demonstrates the analysis criteria are
101102
linked from the [Criteria][cncf-doc-criteria] specification.
@@ -277,10 +278,10 @@ documentation set, but the nature of Backstage makes it especially important
277278
here.
278279

279280
The example roles given in the [comments][proj-doc-comments] have been carried
280-
over to the [Implementation][implementation] section. Contributors with a
281-
greater understanding of how Backstage is used should feel free to modify this
282-
list if it serves the needs of the project, keeping in mind that the purpose of
283-
the user roles is to organize the task-based documentation.
281+
over to [Implementation][implementation-doc]. Contributors with a greater
282+
understanding of how Backstage is used should feel free to modify this list if
283+
it serves the needs of the project, keeping in mind that the purpose of the user
284+
roles is to organize the task-based documentation.
284285

285286
### Develop instructional documentation
286287

@@ -405,7 +406,7 @@ There is an active [Discussions][backstage-discussion] board in the GitHub repo.
405406
page][backstage-github-community] on GitHub. Help resources are not linked from
406407
the Getting Started documentation.
407408

408-
Backstage is listed in the [Clotributor][clotributor] tool.
409+
Backstage is listed in the [Clotributor][] tool.
409410

410411
### Project governance documentation
411412

@@ -416,8 +417,7 @@ Governance is clearly documented in [GOVERNANCE.md][backstage-governance].
416417
As an open source project, Backstage looks healthy and well run.
417418

418419
The only recommendation here is to disentangle the contributor documentation
419-
from the product documentation, as described in the [Information architecture
420-
recommendations][info-arch-recommend].
420+
from the product documentation.
421421

422422
# Website
423423

@@ -577,14 +577,12 @@ Improve compliance in these areas:
577577
- **Images** should have alternative text.
578578
- **Links** should have discernible text.
579579

580-
<!--- References --->
581-
582580
[backstage-backstage]: https://github.com/backstage/backstage
583581
[backstage-community]: https://backstage.io/community
584582
[backstage-contrib]:
585583
https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md
586584
[backstage-demo]:
587-
https://demo.backstage.io/catalog?filters%5Bkind%5D=component&filters%5Buser%5D=owned
585+
https://demo.backstage.io/catalog?no-link-check&filters%5Bkind%5D=component&filters%5Buser%5D=owned
588586
[backstage-discussion]: https://discord.gg/backstage-687207715902193673
589587
[backstage-doc-contrib]:
590588
https://backstage.io/docs/contribute/getting-involved#write-documentation-or-improve-the-website
@@ -628,8 +626,6 @@ Improve compliance in these areas:
628626
[contrib-doc-rec]: #recommendations-contributor-documentation
629627
[contributor-doc]: #contributor-documentation
630628
[doc-survey]: backstage-doc-survey.csv
631-
[implementation]: #implementation
632-
[info-arch-recommend]: #recommendations
633629
[proj-doc-comments]: #comments-project-documentation
634630
[proj-doc-rec]: #recommendations-project-documentation
635631
[proj-doc]: #project-documentation

analyses/0008-backstage/backstage-glossary.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## API
44

55
In the Backstage [Catalog](#catalog), an API is an [entity](#entity)
6-
representing a boundary between two [compnents](#component).
6+
representing a boundary between two [components](#component).
77

88
https://backstage.io/docs/features/software-catalog/system-model
99

@@ -41,7 +41,7 @@ declarative APIs exemplify this approach."
4141
## Cloud Native Computing Foundation
4242

4343
A foundation dedicated to the promotion and advancement of
44-
[Cloud Native Computing](#Cloud-Native-Computing). The mission of the Cloud
44+
[Cloud Native Computing](#cloud-native-computing). The mission of the Cloud
4545
Native Computing Foundation (CNCF) is "to make cloud native computing
4646
ubiquitous"
4747
([CNCF Charter](https://github.com/cncf/foundation/blob/main/charter.md)).
@@ -91,7 +91,7 @@ https://backstage.io/docs/features/software-catalog/system-model
9191
## Entity
9292

9393
What is cataloged in the Backstage Software Catalog. An entity is identified by
94-
[kind](#Kind), [namespace](#Namespace), and name.
94+
[kind](#kind), [namespace](#namespace), and name.
9595

9696
## Evaluator
9797

@@ -106,7 +106,7 @@ with another software system. A [user role](#user-role).
106106

107107
## Kind
108108

109-
Classification of an [entity](#Entity) in the Backstage Software Catalog, for
109+
Classification of an [entity](#entity) in the Backstage Software Catalog, for
110110
example _service_, _database_, and _team_.
111111

112112
## Kubernetes Plugin
@@ -126,7 +126,7 @@ organize [entities](#entity).
126126

127127
## Objective
128128

129-
A high level goal of a [user role](#User-Role) interacting with Backstage. Some
129+
A high level goal of a [user role](#user-role) interacting with Backstage. Some
130130
goals of the _administrator_ user role, for example, are to maintain an instance
131131
("app") of Backstage; to add and update functionality via plugins; and to
132132
troubleshoot issues.
@@ -147,8 +147,8 @@ the core features, are implemented as plugins.
147147
## Procedure
148148

149149
A set of actions that accomplish a goal, usually as part of a
150-
[use case](#Use-Case). A procedure can be high-level, containing other
151-
procedures, or can be as simple as a single [task](#Task).
150+
[use case](#use-case). A procedure can be high-level, containing other
151+
procedures, or can be as simple as a single [task](#task).
152152

153153
## Resource
154154

@@ -160,13 +160,13 @@ https://backstage.io/docs/features/software-catalog/system-model
160160

161161
## Role
162162

163-
See [User Role](#User-Role).
163+
See [User Role](#user-role).
164164

165165
## Search
166166

167167
A Backstage plugin that provides a framework for searching a Backstage
168-
[app](#app), including the [Software Catalog](#Software-Catalog) and
169-
[TechDocs](#TechDocs). One of the core features of Backstage.
168+
[app](#app), including the [Software Catalog](#software-catalog) and
169+
[TechDocs](#techdocs). One of the core features of Backstage.
170170

171171
## Software Catalog
172172

@@ -190,7 +190,7 @@ https://backstage.io/docs/features/software-catalog/system-model
190190

191191
## Task
192192

193-
A low-level step-by-step [Procedure](#Procedure).
193+
A low-level step-by-step [Procedure](#procedure).
194194

195195
## TechDocs
196196

@@ -200,7 +200,7 @@ Backstage.
200200

201201
## Use Case
202202

203-
A purpose for which a [user role](#User-Role) interacts with Backstage. Related
203+
A purpose for which a [user role](#user-role) interacts with Backstage. Related
204204
to [Objective](#objective): An objective is _what_ the user wants to do; a use
205205
case is _how_ the user does it.
206206

analyses/0008-backstage/backstage-implementation.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
title: Implementing Backstage Doc Improvements
33
tags: backstage
4+
cSpell:ignore: rigeur runbooks toolkits
45
---
56

67
# Introduction
78

89
This document provides actionable suggestions for improving the Backstage
9-
technical documentaiton.
10+
technical documentation.
1011

1112
For an analysis and general discussion of recommendations on Backstage technical
1213
documentation, see [backstage-analysis.md][backstage-analysis]].
@@ -142,7 +143,7 @@ The following artifacts should be written and made findable for administrators.
142143
- Install and configure Backstage plugins
143144
- Manage the many software dependencies for Backstage and its plugins
144145
- Maintain the Backstage database
145-
- Upgrade and downgrade the Backstage release verison
146+
- Upgrade and downgrade the Backstage release version
146147
- Troubleshoot common problems
147148
- Tune server performance
148149

@@ -153,7 +154,7 @@ The following artifacts should be written and made findable for developers.
153154
1. A getting started guide for developers. Provide a clear work path that
154155
describes how to:
155156

156-
1. Downloead and install any necessary software components
157+
1. Download and install any necessary software components
157158
1. Integrate Backstage with an existing development environment
158159

159160
1. A User Guide for developers. Provide clear instructions for these tasks:
@@ -173,7 +174,7 @@ issues. For integrators, at a high level, a program should be undertaken to:
173174
1. Organize integrator tasks from most basic and common (write a simple plugin;
174175
decide between backend and frontend plugin) to more complex (integrate with
175176
external systems; use a proxy; implement authentication).
176-
2. Where possible, using the exisitng documentation as a starting point, write
177+
2. Where possible, using the existing documentation as a starting point, write
177178
step-by-step procedures for discrete integration tasks (starting with how to
178179
write a basic plugin).
179180
3. Organize existing reference and conceptual information (such as API

analyses/0008-backstage/backstage-insights-summary.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
cSpell:ignore: flipside
3+
---
4+
15
# Backstage Insights
26

37
This document briefly summarizes the research, branded "Backstage Insight," done
@@ -21,7 +25,7 @@ Adoption here means:
2125
3. Automate development using Backstage, including integrating Backstage with
2226
other development support systems.
2327
3. Backstage must be recognized throughout the organization as the "source of
24-
truth" about all software development within the organizaiton.
28+
truth" about all software development within the organization.
2529

2630
### Barriers to Adoption
2731

@@ -85,7 +89,7 @@ number one outcome for both internal and external users was to **maintain clear
8589
ownership of software**.
8690

8791
For external adopters, other top outcomes were consistent with _improving the
88-
maturity level of their development practices_, for example standarizing
92+
maturity level of their development practices_, for example standardizing
8993
software development practices and increasing collaboration. For internal
9094
adopters, other top outcomes were goals that relied on already-mature
9195
development practices, for example improving monitoring and tracking costs. The

analyses/0010-etcd/etcd-issues.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ including:
4545

4646
- _Evaluator_: Someone trying to determine whether etcd is appropriate for their
4747
product, project, or organization.
48-
- _Admin or Operator_: Someonereponsible for setting up and maintaining a
48+
- _Admin or Operator_: Someone responsible for setting up and maintaining a
4949
standalone (non-Kubernetes-backstore) production etcd service.
5050
- _Kubernetes Admin_: Someone responsible for a Kubernetes cluster using etcd as
5151
a backstore.
@@ -265,7 +265,7 @@ Sections to be added to the table of contents.
265265
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
266266
| Reference | A library of reference documents: APIs, CLIs, configuration options, and anything else a user might need to look up to complete a task. |
267267
| Troubleshooting | A list of procedures for diagnosing and fixing problems. |
268-
| Release Notes | The cumulative release notes for the major and minor release. See [Release Notes](#add-release-notes-to-new-releases). |
268+
| Release Notes | The cumulative release notes for the major and minor release. |
269269

270270
### Remove pages
271271

@@ -279,7 +279,7 @@ that page is listed as "Redundant with". Page URLs are relative to
279279
| -------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------- | ----------------------------------------------------------------------------- |
280280
| demo/ | | op-guide/authentication/authentication/ | Remove |
281281
| dev-internal/discovery_protocol/ | op-guide/clustering/ | dev-guide/discovery_protocol/ | Remove |
282-
| /dev-guide/interacting_v3/ | dev-guide/local_cluster/ | tutorials/\*.md | Consolidate under "Tasks". See [Tutorials](#tutorials) |
282+
| /dev-guide/interacting_v3/ | dev-guide/local_cluster/ | tutorials/\*.md | [Consolidate under "Tasks"](#issue-convert-tutorials-to-tasks) |
283283
| op-guide/recovery/ | op-guide/failures/, op-guide/runtime-configuration/, op-guide/runtime-reconf-design/ | | Incorporate into Troubleshooting guide |
284284
| op-guide/data_corruption/ | op-guide/monitoring/ | | Incorporate into Troubleshooting guide |
285285
| upgrades/ | | | Remove or archive old upgrade paths if they're no longer needed or supported. |

analyses/0011-keda/keda-analysis.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: KEDA Documentation Analysis
3-
tags: kdeda
43
created: 2024-02-23
54
modified: 2024-04-09
65
author: Dave Welsch (@dwelsch-esi)
7-
cSpell:ignore: Welsch dwelsch pastable
6+
cSpell:ignore: Welsch dwelsch pastable servicedesk
87
---
98

109
# Introduction
@@ -383,9 +382,9 @@ KEDA is a **graduated** project of CNCF. This means that the project should have
383382
### Single-source requirement
384383

385384
Source files for all website pages reside in a **single repo**. However, some
386-
user documentation pages (speciifically, "Getting started" topics linked from
387-
the main (kedacore/keda) repo) would better serve users if they were moved to
388-
the tech docs on the website.
385+
user documentation pages (specifically, "Getting started" topics linked from the
386+
main (kedacore/keda) repo) would better serve users if they were moved to the
387+
tech docs on the website.
389388

390389
Website files are all in the website repo.
391390

@@ -403,7 +402,7 @@ sandbox, incubating, graduated and archived.
403402
| Maturity | Requirement | Met? |
404403
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
405404
| Sandbox | Majority of [Website guidelines](../../docs/website-guidelines-checklist.md) satisfied | Yes |
406-
| Sandbox | [Docs assessment](../../docs/analysis/howto.md) [cncf-servicedesk] completed. | Yes |
405+
| Sandbox | [Docs assessment](../../docs/analysis/howto.md) [CNCF-servicedesk] completed. | Yes |
407406
| Sandbox | **Project documentation** exists – somewhere. It is acceptable at this maturity level to link out to documentation that hasn't yet been integrated into the website. (May still be in the project GitHub repo, for example.) | Yes |
408407
| Incubating | All [Website guidelines](../../docs/analysis/criteria.md#website) satisfied | Yes |
409408
| Incubating | Request docs (re-)assessment through CNCF [service desk](https://servicedesk.cncf.io/) | Yes |
@@ -538,3 +537,5 @@ Explicitly list and solicit maintainers and contributors for documentation.
538537
No recommendations.
539538

540539
<!--- References --->
540+
541+
[CNCF-servicedesk]: https://servicedesk.cncf.io

0 commit comments

Comments
 (0)