fix: spelling errors and add spellcheck CI workflow#395
fix: spelling errors and add spellcheck CI workflow#395hharshhsaini wants to merge 1 commit intokubeedge:mainfrom
Conversation
Fix various spelling errors in documentation and code comments: - contributrbute -> contribute (how-to-contribute-algorithms.md) - enviroment -> environment (how-to-build-simulation-env.md, simulation.md) - moudles -> modules (how-to-build-simulation-env.md, simulation.md) - funcitons -> functions (how-to-build-simulation-env.md, simulation.md) - framwork -> framework (simulation.md) - simualtion -> simulation (simulation.md) - Congratulation -> Congratulations (how-to-build-simulation-env.md) - LadeSepcDec -> LadeSpecDec (test_queryrouting.yaml) Add CI spellcheck workflow for .md files: - Add .spellcheck.yml with pyspelling + aspell (en_US) - Add .wordlist.txt for project-specific technical terms - Add .github/workflows/spellcheck.yml: - Triggers only on .md file changes (push/PR) - Non-blocking (continue-on-error: true) - advisory only - Uses pyspelling with markdown filter Fixes kubeedge#232 Signed-off-by: hharshhsaini <sainiharsh3311@gmail.com>
kubeedge-bot
added
kind/cleanup
|
Welcome @hharshhsaini! It looks like this is your first PR to kubeedge/ianvs 🎉 |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: hharshhsaini The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kubeedge-bot
added
the
size/L
|
Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages. The list of commits with invalid commit messages:
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request implements automated spellchecking by adding a .spellcheck.yml configuration and a .wordlist.txt dictionary, while also correcting various typos in the documentation. The review feedback highlights a syntax error in the YAML configuration, notes a missing CI workflow file, and provides several suggestions for grammatical improvements and subject-verb agreement in the updated documentation files.
| pipeline: | ||
| - pyspelling.filters.markdown: | ||
| markdown_extensions: | ||
| - markdown.extensions.extra: |
There was a problem hiding this comment.
The trailing colon in markdown.extensions.extra: makes it a dictionary key with a null value in YAML. In the context of pyspelling and the markdown library, this should be a string literal representing the extension name. Also, please note that the .github/workflows/spellcheck.yml file mentioned in the PR description is missing from the provided changes, which will prevent the CI from actually running.
- markdown.extensions.extra| 3. build the simulation environment | ||
| 4. create and deploy the modules needed in simulation environment | ||
| 5. close and delete the simulation environment | ||
| - The `Simulation Job Administrator` is the core module for manage the simulation job, and provides the following functions: |
There was a problem hiding this comment.
Grammar improvement: "for manage" should be "for managing" to be grammatically correct.
| - The `Simulation Job Administrator` is the core module for manage the simulation job, and provides the following functions: | |
| - The Simulation Job Administrator is the core module for managing the simulation job, and provides the following functions: |
| See Pod status: kubectl -n sedna get pod | ||
| [I1029 01:16:56.974] Mini Sedna is created successfully | ||
| [2022-10-29 01:17:12,880] simulation_system_admin.py(170) [INFO] - Congratulation! The simulation enviroment build successful! | ||
| [2022-10-29 01:17:12,880] simulation_system_admin.py(170) [INFO] - Congratulations! The simulation environment build successful! |
There was a problem hiding this comment.
Grammar improvement: "build successful" should be "build was successful" or "built successfully". Additionally, please note that the underlying log message in core/testcasecontroller/simulation_system_admin/simulation_system_admin.py (line 170) still contains the spelling errors Congratulation and enviroment. It is recommended to update the source code to match the corrected documentation.
| [2022-10-29 01:17:12,880] simulation_system_admin.py(170) [INFO] - Congratulations! The simulation environment build successful! | |
| [2022-10-29 01:17:12,880] simulation_system_admin.py(170) [INFO] - Congratulations! The simulation environment build was successful! |
|  | ||
|
|
||
| In the framwork of ianvs, the `simulation controller` is the core module of system simulation. The `simulation controller` has been supplemented, which build and deploy local edge-cloud simulation environment with K8s. | ||
| In the framework of ianvs, the `simulation controller` is the core module of system simulation. The `simulation controller` has been supplemented, which build and deploy local edge-cloud simulation environment with K8s. |
There was a problem hiding this comment.
Grammar improvement: "which build and deploy" should be "which builds and deploys" to correctly agree with the singular subject "simulation controller".
| In the framework of ianvs, the `simulation controller` is the core module of system simulation. The `simulation controller` has been supplemented, which build and deploy local edge-cloud simulation environment with K8s. | |
| In the framework of ianvs, the simulation controller is the core module of system simulation. The simulation controller has been supplemented, which builds and deploys local edge-cloud simulation environment with K8s. |
| 3. build the simulation environment | ||
| 4. create and deploy the modules needed in simulation environment | ||
| 5. close and delete the simulation environment | ||
| - The `Simulation Job Administrator` is the core module for manage the simulation job, and provides the following functions: |
There was a problem hiding this comment.
Grammar improvement: "for manage" should be "for managing".
| - The `Simulation Job Administrator` is the core module for manage the simulation job, and provides the following functions: | |
| - The Simulation Job Administrator is the core module for managing the simulation job, and provides the following functions: |
| - parse simulation config | ||
|
|
||
| 4. `Simulation System Administrator` build the environment and create needed moudles. | ||
| 4. `Simulation System Administrator` build the environment and create needed modules. |
There was a problem hiding this comment.
Grammar improvement: "build" and "create" should be "builds" and "creates" to match the singular subject.
| 4. `Simulation System Administrator` build the environment and create needed modules. | |
| 4. Simulation System Administrator builds the environment and creates needed modules. |
| - generate the YAML of simulation job base on `testenv.yaml` and `algorithm.yaml` | ||
| - deploy simulation job: access k8s API-server via `python-k8sclient` to deploy simulation jobs | ||
| 6. `Simulation Job Administrator` list-watch the configmap of results: ianvs-simualtion-job-result | ||
| 6. `Simulation Job Administrator` list-watch the configmap of results: ianvs-simulation-job-result |
There was a problem hiding this comment.
Grammar improvement: "list-watch" should be "list-watches" for subject-verb agreement.
| 6. `Simulation Job Administrator` list-watch the configmap of results: ianvs-simulation-job-result | |
| 6. Simulation Job Administrator list-watches the configmap of results: ianvs-simulation-job-result |
| - list-watch the simulation jobs in K8s | ||
| - run the simulation jobs | ||
| 8. `Simulation Job Controller` save results of simulation job to configmap: ianvs-simualtion-job-result | ||
| 8. `Simulation Job Controller` save results of simulation job to configmap: ianvs-simulation-job-result |
There was a problem hiding this comment.
Grammar improvement: "save" should be "saves" for subject-verb agreement.
| 8. `Simulation Job Controller` save results of simulation job to configmap: ianvs-simulation-job-result | |
| 8. Simulation Job Controller saves results of simulation job to configmap: ianvs-simulation-job-result |
2 participants
What type of PR is this?
/kind cleanup
/kind documentation
/kind feature
What this PR does / why we need it:
This PR addresses two parts of issue #232:
Part 1: Fix existing spelling errors in documentation and code comments
contributrbutecontributedocs/guides/how-to-contribute-algorithms.mdenviromentenvironmentdocs/guides/how-to-build-simulation-env.md,docs/proposals/simulation/simulation.mdmoudlesmodulesdocs/guides/how-to-build-simulation-env.md,docs/proposals/simulation/simulation.mdfuncitonsfunctionsdocs/guides/how-to-build-simulation-env.md,docs/proposals/simulation/simulation.mdframworkframeworkdocs/proposals/simulation/simulation.mdsimualtionsimulationdocs/proposals/simulation/simulation.mdCongratulationCongratulationsdocs/guides/how-to-build-simulation-env.mdLadeSepcDecLadeSpecDecexamples/cloud-edge-collaborative-inference-for-llm/testalgorithms/query-routing/test_queryrouting.yamlPart 2: Add CI spellcheck workflow for
.mdfiles.spellcheck.yml- pyspelling config usingaspell(en_US) with markdown filter.wordlist.txt- custom dictionary for project-specific technical terms (e.g., Ianvs, KubeEdge, vLLM, TTFT).github/workflows/spellcheck.yml- GitHub Actions workflow that:.mdfile changes (push to main / PR)continue-on-error: true) - gives advisory suggestions before merging, not as a merge barrierpyspellingwithaspellfor spell checkingThis addresses all the review feedback from the previous PR #240:
codefilter (pyspelling ignores code blocks by default)Which issue(s) this PR fixes:
Fixes #232