Skip to content

Commit 1c10ff3

Browse files
authored
Canonicalize README links, cleanup package.json (#326)
1 parent 00e2616 commit 1c10ff3

File tree

2 files changed

+28
-26
lines changed

2 files changed

+28
-26
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
This site contains resources provided by the CNCF Technical Documentation team,
44
including:
55

6-
- [Docs](docs) about building websites and developing technical documentation,
6+
- [Docs](docs/) about building websites and developing technical documentation,
77
including recommended tools, best practices, how-tos, and evaluation
88
checklists. It provides specific guidelines for:
99
- Setting up and maintaining a documentation website.
1010
- Writing technical documentation for a project.
1111
- Seeking assistance from the CNCF TechDocs community.
1212
- [Analyzing project documentation](docs/analysis/).
13-
- [Analyses](analyses): a collection of documentation analyses of CNCF projects
13+
- [Analyses](analyses/): a collection of documentation analyses of CNCF projects
1414
performed by the TechDocs team.
1515

1616
## TechDocs Q&A

package.json

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,46 @@
33
"version": "0.0.0",
44
"description": "Resources provided by the CNCF Technical Documentation team.",
55
"scripts": {
6-
"_build": "docusaurus build",
6+
"_build": "npm run docus:build",
77
"_check:format:any": "npx prettier --check --ignore-path ''",
88
"_check:format:delta": "npm run _check:format:any -- $(npm run -s _list:git:delta)",
99
"_check:format": "npx prettier --check .",
1010
"_check:links-md": "bash -c 'for f in *.md `find analyses -name \"*.md\"`; do npx markdown-link-check --config .markdown-link-check.json -p -v $f || exit 1; done'",
1111
"_check:links:internal": "npm run _check:links -- HTMLTEST_ARGS='--skip-external'",
1212
"_check:links": "make --keep-going check-links",
13+
"_check:markdown:1": "npx -p markdownlint-cli markdownlint -c .markdownlint.yaml",
1314
"_check:markdown:all": "npm run -s _list:check:md | xargs -I {} -P 4 npx -p markdownlint-cli markdownlint -c .markdownlint.yaml {}",
1415
"_check:markdown:delta": "npm run -s _list:git:delta | xargs -I {} npx -p markdownlint-cli markdownlint -c .markdownlint.yaml {}",
15-
"_check:markdown:1": "npx -p markdownlint-cli markdownlint -c .markdownlint.yaml",
16-
"_list:git:delta": "git diff --name-only --diff-filter=ACMR | grep -E '\\.(js|md|scss|yml|yaml)$'",
16+
"_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$'",
1717
"_list:check:md:no-analysis": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' -a -not -path '*/00*'",
1818
"_list:check:md": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' | grep -Eve '/000|/0010'",
19-
"_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$'",
2019
"_list:fix:*": "npm run --loglevel=warn | grep -Ee '^\\s*fix:[^:]+$' | grep -v 'fix:all'",
20+
"_list:git:delta": "git diff --name-only --diff-filter=ACMR | grep -E '\\.(js|md|scss|yml|yaml)$'",
21+
"build:preview": "npm run _build",
22+
"build:production": "npm run _build",
23+
"build": "BUILD_ENV=dev npm run _build",
2124
"check:format": "npm run _check:format || (echo '[help] Run: npm run fix:format'; exit 1)",
2225
"check:links": "npm run _check:links",
2326
"check:markdown": "npm run _check:markdown:all",
2427
"check:spelling": "npx cspell --no-progress -c .cspell.yml analyses docs *.md",
2528
"check": "npm run seq -- $(npm run -s _list:check:*)",
29+
"docus:build": "docusaurus build",
30+
"docus:clear": "docusaurus clear",
31+
"docus:deploy": "docusaurus deploy",
32+
"docus:serve": "docusaurus serve",
33+
"docus:start": "docusaurus start",
34+
"docus:swizzle": "docusaurus swizzle",
35+
"docus:write-heading-ids": "docusaurus write-heading-ids",
36+
"docus:write-translations": "docusaurus write-translations",
37+
"docusaurus": "docusaurus",
2638
"fix:format": "npm run _check:format -- --write",
2739
"fix": "npm run seq -- $(npm -s run _list:fix:*)",
2840
"precheck:links": "npm run build",
2941
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
42+
"serve": "npm run docus:serve",
3043
"test": "npm run check",
31-
"update:pkgs": "npx npm-check-updates -u",
32-
"docusaurus": "docusaurus",
33-
"start": "docusaurus start",
34-
"build:preview": "npm run _build",
35-
"build:production": "npm run _build",
36-
"build": "BUILD_ENV=dev npm run _build",
37-
"swizzle": "docusaurus swizzle",
38-
"deploy": "docusaurus deploy",
39-
"clear": "docusaurus clear",
40-
"serve": "docusaurus serve",
41-
"write-translations": "docusaurus write-translations",
42-
"write-heading-ids": "docusaurus write-heading-ids",
43-
"typecheck": "tsc"
44+
"typecheck": "tsc",
45+
"update:pkgs": "npx npm-check-updates -u"
4446
},
4547
"author": "CNCF",
4648
"license": "CC-BY-4.0",
@@ -50,23 +52,23 @@
5052
"@mdx-js/react": "^3.1.0",
5153
"clsx": "^2.1.1",
5254
"prism-react-renderer": "^2.4.1",
53-
"react": "^19.1.0",
54-
"react-dom": "^19.1.0"
55+
"react-dom": "^19.1.0",
56+
"react": "^19.1.0"
5557
},
5658
"devDependencies": {
59+
"@docusaurus/module-type-aliases": "3.8.1",
60+
"@docusaurus/tsconfig": "3.8.1",
61+
"@docusaurus/types": "3.8.1",
5762
"cspell": "^9.1.1",
5863
"markdown-link-check": "3.13.7",
59-
"markdownlint": "^0.38.0",
6064
"markdownlint-cli": "^0.45.0",
65+
"markdownlint": "^0.38.0",
6166
"npm-check-updates": "^18.0.1",
6267
"prettier": "^3.5.3",
63-
"@docusaurus/module-type-aliases": "3.8.1",
64-
"@docusaurus/tsconfig": "3.8.1",
65-
"@docusaurus/types": "3.8.1",
6668
"typescript": "~5.8.3"
6769
},
6870
"private": true,
69-
"spelling": "cSpell:ignore ACMR HTMLTEST loglevel pkgs -",
71+
"spelling": "cSpell:ignore ACMR docus HTMLTEST loglevel pkgs -",
7072
"prettier": {
7173
"proseWrap": "always",
7274
"singleQuote": true

0 commit comments

Comments
 (0)