Skip to content

Commit 1ebfabb

Browse files
authored
Chore: Fix all broken links outlined in issue description (#345)
* Chore: Fix all broken links outlined in issue description Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: format files Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error again Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix link checker in CI Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: add backsticks to link Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com>
1 parent f658514 commit 1ebfabb

7 files changed

Lines changed: 20 additions & 17 deletions

File tree

.htmltest.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ IgnoreInternalURLs: # list of paths
77
IgnoreURLs: # list of regexes of URLs or path to be ignored
88
- ^https?://localhost
99
- \?no-link-check
10+
- _PROJECT-WEBSITE_
11+
- _PROJECT-DOC-URL_
1012
# FIXME: temporary ignore rules
1113
- assistance\.md
1214
- LICENSE

analyses/2023/etcd/etcd-analysis.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Netlify platform. The site's code is stored on the etcd GitHub repo.
5555

5656
**Out of scope:**
5757

58-
- Other etcd repos: https://github.com/etcd-io/*
58+
- Other etcd repos: `https://github.com/etcd-io/*`
5959

6060
## How this document is organized
6161

@@ -299,9 +299,10 @@ The website has a
299299
Those maintainer **responsible for approving** documentation PRs are listed as
300300
"approvers".
301301

302-
The website repo [README](../../README.md) is out of date. For example,
303-
instructions for building the website state that the local build starts the
304-
server on `localhost:8888`. It's actually `localhost:1313`.
302+
The website repo
303+
[README](https://github.com/etcd-io/website/blob/main/README.md) is out of date.
304+
For example, instructions for building the website state that the local build
305+
starts the server on `localhost:8888`. It's actually `localhost:1313`.
305306

306307
### Inclusive language
307308

analyses/2025/knative/issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ here: https://github.com/cncf/techdocs/tree/main/analyses under `0015-knative`.
196196

197197
Related material in the current doc:
198198

199-
- https://github.com/knative/install
199+
- https://knative.dev/docs/install/
200200

201201
Suggested changes:
202202

@@ -665,7 +665,7 @@ start by looking at the [mkdocs config file].
665665
https://github.com/knative/docs/blob/main/contribute-to-docs/style-guide/voice-and-language.md#avoid-statements-that-will-soon-be-out-of-date
666666
[Install Knative using quickstart]:
667667
https://knative.dev/docs/install/quickstart-install/
668-
[Installing Knative]: https://github.com/knative/install
668+
[Installing Knative]: https://knative.dev/docs/install/
669669
[Installing the Knative CLI]: https://knative.dev/docs/client/install-kn/
670670
[Knative Broker for Apache Kafka]:
671671
https://knative.dev/docs/eventing/brokers/broker-types/kafka-broker/

docs/analysis/templates/analysis.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The accompanying [implementation] document breaks the recommendations down into
104104
concrete actions that can be implemented by project contributors. Its focus is
105105
on drilling down to specific, achievable work that can be completed in
106106
constrained blocks of time. Ultimately, the implementation items are decomposed
107-
into a series of [issues] and entered as GitHub [project-doc-website]/issues.
107+
into a series of issues and entered on GitHub `PROJECT-DOC-WEBSITE/issues`.
108108

109109
### How to use this document
110110

@@ -115,9 +115,9 @@ Readers interested in the current state of the documentation and the reasoning
115115
behind the recommendations should read the section of this document pertaining
116116
to their area of concern:
117117

118-
- [Project documentation](./?TODO=ADD-URL)
119-
- [Contributor documentation](./?TODO=ADD-URL)
120-
- [Website and documentation infrastructure](./?TODO=ADD-URL)
118+
- [Project documentation](#project-documentation)
119+
- [Contributor documentation](#contributor-documentation)
120+
- [Website and documentation infrastructure](#website-and-infrastructure)
121121

122122
Examples of CNCF documentation that demonstrate the analysis criteria are linked
123123
from the [criteria] specification.
@@ -550,8 +550,7 @@ The numeric rating values used in this document are as follows
550550
[criteria]: ../criteria.md
551551
[implementation]: ./implementation.md
552552
[issues list]: ./issues-list.md
553-
[project-doc-website]: ./?_PROJECT-DOC-URL_
554-
[project-website]: ./?_PROJECT-WEBSITE_
553+
[project-website]: _PROJECT-WEBSITE_
555554
[Rating (1-5)]: #rating-values
556555
[rfc-spec]: https://www.rfc-editor.org/rfc/rfc2119
557556
[website guidelines]: ../../website-guidelines-checklist.md

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Consultants and volunteers also contribute to CNCF TechDocs efforts.
5252

5353
## Licenses
5454

55-
- Documentation: [CC-BY-4.0](LICENSE)
56-
- Code: [Apache-2.0](LICENSE-CODE)
55+
- Documentation: [CC-BY-4.0](https://github.com/cncf/techdocs/blob/main/LICENSE)
56+
- Code: [Apache-2.0](https://github.com/cncf/techdocs/blob/main/LICENSE-CODE)
5757

5858
[date-time]:
5959
https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours

docs/repo-setup.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,11 @@ For documentation this means you must:
3939
```markdown
4040
# License
4141

42-
$PROJECT_NAME is licensed under an [Apache 2.0 license](./LICENSE).
42+
$PROJECT_NAME is licensed under an
43+
[Apache 2.0 license](https://github.com/cncf/techdocs/blob/main/LICENSE-CODE).
4344

4445
The #PROJECT_NAME documentation is licensed under a
45-
[CC-BY-4.0 license](./LICENSE-docs).
46+
[CC-BY-4.0 license](https://github.com/cncf/techdocs/blob/main/LICENSE).
4647
```
4748

4849
2. Add both the CC-BY-4.0 `LICENSE-docs` and Apache 2.0 `LICENSE` files to the

docs/website-guidelines-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Website guidelines & checklist
55
# Website guidelines & checklist
66

77
Per the
8-
[CNCF Website Guidelines](https://github.com/cncf/foundation/blob/main/website-guidelines.md),
8+
[CNCF Website Guidelines](https://github.com/cncf/foundation/blob/main/policies-guidance/website-guidelines.md),
99
the following should be present:<br/> _Note_, not all of these are applicable to
1010
all projects
1111

0 commit comments

Comments
 (0)