Skip to content

Commit bc39798

Browse files
committed
Link, title, and filename adjustments
More tweaks Signed-off-by: Patrice Chalin <[email protected]>
1 parent 5b0f892 commit bc39798

File tree

7 files changed

+22
-20
lines changed

7 files changed

+22
-20
lines changed

.cspell.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ version: '0.2'
55
caseSensitive: true
66
ignorePaths:
77
- '*.csv'
8-
- /docs/localization/ja
8+
- /docs/[Ll]ocalization/ja # cSpell:disable-line
99
# patterns:
1010
# - name: CodeBlock
1111
# pattern: |
@@ -20,7 +20,6 @@ ignorePaths:
2020
# ignoreRegExpList:
2121
# - CodeBlock
2222
words:
23-
- nvmrc
2423
- backstore
2524
- CLOTributor
2625
- CNCF
@@ -29,9 +28,9 @@ words:
2928
- kedacore
3029
- krook
3130
- nate
31+
- nvmrc
3232
- subpages
3333
- techdocs
3434
- toolkits
3535
- toto
3636
- triaging
37-
- w.

docs/analysis/templates/analysis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -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](./?TODO=ADD-URL)
119+
- [Contributor documentation](./?TODO=ADD-URL)
120+
- [Website and documentation infrastructure](./?TODO=ADD-URL)
121121

122122
Examples of CNCF documentation that demonstrate the analysis criteria are linked
123123
from the [criteria] specification.
@@ -550,8 +550,8 @@ 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-doc-website]: ./?_PROJECT-DOC-URL_
554+
[project-website]: ./?_PROJECT-WEBSITE_
555555
[Rating (1-5)]: #rating-values
556556
[rfc-spec]: https://www.rfc-editor.org/rfc/rfc2119
557557
[website guidelines]: ../../website-guidelines-checklist.md

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ sidebar_position: 1
55

66
# CNCF Techdocs how-tos
77

8-
This directory contains documentation on how the CNCF TechDocs team does things.
8+
This section contains documentation on how the CNCF TechDocs team does things.
99
While its intent is for the CNCF TechDocs team's use, we encourage project
10-
maintainers to use these documents if you find them helpful!
10+
maintainers to use these documents if you find them helpful.

docs/sandbox-doc-primer.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
title: CNCF sandbox project documentation primer
2+
title: CNCF sandbox-project docs primer
3+
sidebar:
4+
label: Sandbox-project docs primer
35
---
46

5-
# CNCF sandbox project documentation primer
7+
# CNCF sandbox-project docs primer
68

7-
This document is a quick primer for CNCF project maintainers and contributors
9+
This page is a quick primer for CNCF project maintainers and contributors
810
who need to document their projects but don't know where to start. It provides a
911
framework for thinking about user documentation that will enable the project
1012
contributors to write effective documentation from the very beginning and to get
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Documentation Search
2+
title: Site Search
3+
sidebar: { label: Search }
34
---
45

5-
# Documentation Search
6+
# Site Search
67

78
<!-- markdownlint-disable no-duplicate-heading -->
89

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Doc Versioning with Hugo & Netlify
2+
title: Versioned docs with Hugo & Netlify
33
# prettier-ignore
44
cSpell:ignore: Batard Brubaker Pursley velero fullversion githubbranch docsbranch Tanzu Rosland Horgan Takahashi
55
---
66

7-
# Doc Versioning with Hugo & Netlify
7+
# Versioned docs with Hugo & Netlify
88

99
Technical Documents Versioning is an intersection of:
1010

docs/website-guidelines-checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: CNCF website guidelines checklist
2+
title: Website guidelines & checklist
33
---
44

5-
# CNCF website guidelines checklist
5+
# Website guidelines & checklist
66

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

0 commit comments

Comments
 (0)