deckhouse / deckhouse/deckhouse
[linter][docs] Check words on a block list
Open
Nobody has claimed this yet.
area/docs
area/testing
priority/backlog
status/no-stale
type/enhancement
- Dominant language
- Go
- Stars
- 1.3k
- Forks
- 162
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 653
Description
Preflight Checklist
- I agree to follow the Code of Conduct that this project adheres to.
- I have searched the issue tracker for an issue that matches the one I want to file, without success.
Use case. Why is this important?
Documentation must not use incorrectly translated into Russian terms, such as "нода", "ингресс", "нэймспейс".
Proposed Solution
Documentation checker should use a blocklist
Additional Information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Locate the documentation checker and determine where blocked terms should be configured and reported; done means incorrectly translated Russian terms such as "нода", "ингресс", and "нэймспейс" are detected.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100