cncf / techdocs

CNCF TechDocs Team
https://www.cncf.io
Apache License 2.0
37 stars 26 forks source link

Adding Docs Assistance label #249

Closed nate-double-u closed 3 weeks ago

nate-double-u commented 1 month ago

contributes to #247

nate-double-u commented 3 weeks ago

the format check failure:

Run npm run check:format

> techdocs@0.0.0 check:format
> npm run _check:format || (echo '[help] Run: npm run fix:format'; exit 1)

> techdocs@0.0.0 _check:format
> npx prettier --check .

npm WARN exec The following package was not found and will be installed: prettier@3.3.1
Checking formatting...
[warn] analyses/0006-gateway-api.md
[warn] analyses/0010-etcd/etcd-analysis.md
[warn] docs/analysis/criteria.md
[warn] docs/analysis/templates/analysis.md
[warn] docs/analytics.md
[warn] docs/website-guidelines-checklist.md
[warn] Code style issues found in 6 files. Run Prettier with --write to fix.
[help] Run: npm run fix:format
Error: Process completed with exit code 1.

I'm not sure we want to fail a PR because of warning fixes not getting automatically written. Am I reading this correctly @chalin?

chalin commented 3 weeks ago

Prettier 3.3.x formats files differently. We'll need to land the following first:

chalin commented 3 weeks ago

@nate-double-u - btw, in terms of terminology, the folder name is analyses -- and so we're calling each of these an "analysis". Should that be used in the new label you're adding instead of "assistance"?

nate-double-u commented 3 weeks ago

Good question -- I pulled "assistance" from our front page: https://github.com/cncf/techdocs?tab=readme-ov-file#assistance-program-for-technical-documentation.

Probably we need to make a decision and make sure we're consistent across the repo.