diff --git a/.htmltest.yml b/.htmltest.yml index 84e17fd..ea46cd5 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -7,6 +7,8 @@ IgnoreInternalURLs: # list of paths IgnoreURLs: # list of regexes of URLs or path to be ignored - ^https?://localhost - \?no-link-check + - _PROJECT-WEBSITE_ + - _PROJECT-DOC-URL_ # FIXME: temporary ignore rules - assistance\.md - LICENSE diff --git a/analyses/2023/etcd/etcd-analysis.md b/analyses/2023/etcd/etcd-analysis.md index a9d7818..f8a0614 100644 --- a/analyses/2023/etcd/etcd-analysis.md +++ b/analyses/2023/etcd/etcd-analysis.md @@ -55,7 +55,7 @@ Netlify platform. The site's code is stored on the etcd GitHub repo. **Out of scope:** -- Other etcd repos: https://github.com/etcd-io/* +- Other etcd repos: `https://github.com/etcd-io/*` ## How this document is organized @@ -299,9 +299,10 @@ The website has a Those maintainer **responsible for approving** documentation PRs are listed as "approvers". -The website repo [README](../../README.md) is out of date. For example, -instructions for building the website state that the local build starts the -server on `localhost:8888`. It's actually `localhost:1313`. +The website repo +[README](https://github.com/etcd-io/website/blob/main/README.md) is out of date. +For example, instructions for building the website state that the local build +starts the server on `localhost:8888`. It's actually `localhost:1313`. ### Inclusive language diff --git a/analyses/2025/knative/issues.md b/analyses/2025/knative/issues.md index c3314a1..3e74e1a 100644 --- a/analyses/2025/knative/issues.md +++ b/analyses/2025/knative/issues.md @@ -196,7 +196,7 @@ here: https://github.com/cncf/techdocs/tree/main/analyses under `0015-knative`. Related material in the current doc: -- https://github.com/knative/install +- https://knative.dev/docs/install/ Suggested changes: @@ -665,7 +665,7 @@ start by looking at the [mkdocs config file]. 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 [Install Knative using quickstart]: https://knative.dev/docs/install/quickstart-install/ -[Installing Knative]: https://github.com/knative/install +[Installing Knative]: https://knative.dev/docs/install/ [Installing the Knative CLI]: https://knative.dev/docs/client/install-kn/ [Knative Broker for Apache Kafka]: https://knative.dev/docs/eventing/brokers/broker-types/kafka-broker/ diff --git a/docs/analysis/templates/analysis.md b/docs/analysis/templates/analysis.md index e6103fa..f37e7b7 100644 --- a/docs/analysis/templates/analysis.md +++ b/docs/analysis/templates/analysis.md @@ -104,7 +104,7 @@ The accompanying [implementation] document breaks the recommendations down into concrete actions that can be implemented by project contributors. Its focus is on drilling down to specific, achievable work that can be completed in constrained blocks of time. Ultimately, the implementation items are decomposed -into a series of [issues] and entered as GitHub [project-doc-website]/issues. +into a series of issues and entered on GitHub `PROJECT-DOC-WEBSITE/issues`. ### How to use this document @@ -115,9 +115,9 @@ Readers interested in the current state of the documentation and the reasoning behind the recommendations should read the section of this document pertaining to their area of concern: -- [Project documentation](./?TODO=ADD-URL) -- [Contributor documentation](./?TODO=ADD-URL) -- [Website and documentation infrastructure](./?TODO=ADD-URL) +- [Project documentation](#project-documentation) +- [Contributor documentation](#contributor-documentation) +- [Website and documentation infrastructure](#website-and-infrastructure) Examples of CNCF documentation that demonstrate the analysis criteria are linked from the [criteria] specification. @@ -550,8 +550,7 @@ The numeric rating values used in this document are as follows [criteria]: ../criteria.md [implementation]: ./implementation.md [issues list]: ./issues-list.md -[project-doc-website]: ./?_PROJECT-DOC-URL_ -[project-website]: ./?_PROJECT-WEBSITE_ +[project-website]: _PROJECT-WEBSITE_ [Rating (1-5)]: #rating-values [rfc-spec]: https://www.rfc-editor.org/rfc/rfc2119 [website guidelines]: ../../website-guidelines-checklist.md diff --git a/docs/index.md b/docs/index.md index 6d837e3..4fca64e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -52,8 +52,8 @@ Consultants and volunteers also contribute to CNCF TechDocs efforts. ## Licenses -- Documentation: [CC-BY-4.0](LICENSE) -- Code: [Apache-2.0](LICENSE-CODE) +- Documentation: [CC-BY-4.0](https://github.com/cncf/techdocs/blob/main/LICENSE) +- Code: [Apache-2.0](https://github.com/cncf/techdocs/blob/main/LICENSE-CODE) [date-time]: https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours diff --git a/docs/repo-setup.md b/docs/repo-setup.md index bf7003c..670bc10 100644 --- a/docs/repo-setup.md +++ b/docs/repo-setup.md @@ -39,10 +39,11 @@ For documentation this means you must: ```markdown # License - $PROJECT_NAME is licensed under an [Apache 2.0 license](./LICENSE). + $PROJECT_NAME is licensed under an + [Apache 2.0 license](https://github.com/cncf/techdocs/blob/main/LICENSE-CODE). The #PROJECT_NAME documentation is licensed under a - [CC-BY-4.0 license](./LICENSE-docs). + [CC-BY-4.0 license](https://github.com/cncf/techdocs/blob/main/LICENSE). ``` 2. Add both the CC-BY-4.0 `LICENSE-docs` and Apache 2.0 `LICENSE` files to the diff --git a/docs/website-guidelines-checklist.md b/docs/website-guidelines-checklist.md index f4ba814..9c7d425 100644 --- a/docs/website-guidelines-checklist.md +++ b/docs/website-guidelines-checklist.md @@ -5,7 +5,7 @@ title: Website guidelines & checklist # Website guidelines & checklist Per the -[CNCF Website Guidelines](https://github.com/cncf/foundation/blob/main/website-guidelines.md), +[CNCF Website Guidelines](https://github.com/cncf/foundation/blob/main/policies-guidance/website-guidelines.md), the following should be present:
_Note_, not all of these are applicable to all projects