Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Docs Assistance label #249

Merged
merged 3 commits into from
Jun 6, 2024

Conversation

nate-double-u
Copy link
Member

contributes to #247

@nate-double-u nate-double-u requested a review from chalin May 31, 2024 22:32
.github/settings.yml Outdated Show resolved Hide resolved
@nate-double-u
Copy link
Member Author

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
Copy link
Collaborator

chalin commented Jun 6, 2024

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

@chalin
Copy link
Collaborator

chalin commented Jun 6, 2024

@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
Copy link
Member Author

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.

nate-double-u and others added 2 commits June 6, 2024 10:41
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
@nate-double-u nate-double-u force-pushed the adding-docs-assistance-label branch from 99b6bef to c26ebfc Compare June 6, 2024 17:41
.github/settings.yml Outdated Show resolved Hide resolved
Co-authored-by: Nate W <natew@cncf.io>
Signed-off-by: Patrice Chalin <chalin@users.noreply.github.com>
Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thx!

@nate-double-u nate-double-u merged commit fa00ecc into cncf:main Jun 6, 2024
4 checks passed
@nate-double-u nate-double-u deleted the adding-docs-assistance-label branch June 6, 2024 19:03
@nate-double-u nate-double-u added the CI/infra CI & infrastructure label Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants