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

Enable non-english dictionaries #360

Closed

Conversation

electrocucaracha
Copy link
Collaborator

@electrocucaracha electrocucaracha commented Jan 28, 2022

PySpelling tool can be configured to validate another languages, for example spanish.

This change moves the English spellchecker configuration into its own content folder. This approach allows to isolate the spellchecker execution by language or branch.

It's possible to validate this change locally thru the act tool running the act -j check-english-spellcheck command.

Note: Some words were removed from the English wordlist

@netlify
Copy link

netlify bot commented Jan 28, 2022

✔️ Deploy Preview for cncfglossary ready!

🔨 Explore the source changes: afcbff7

🔍 Inspect the deploy log: https://app.netlify.com/sites/cncfglossary/deploys/61fdb5098396c100088d2ea4

😎 Browse the preview: https://deploy-preview-360--cncfglossary.netlify.app

@JasonMorgan
Copy link
Collaborator

Hey @electrocucaracha thanks for taking the time to chat with me today! As per our conversation please add some documentation explaining how to add support for a new language as well as documentation covering running the spellchecker locally. With that I should be able to get this merged by the end of the week. cc @seokho-son

Copy link
Collaborator

@seokho-son seokho-son left a comment

Choose a reason for hiding this comment

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

@electrocucaracha Thank you for the contribution to improve workflow :)

First of all, I need to share following situation.

  • Each localization team supposed to use their own development branch (ex: dev-pt)
  • There is no development branch for Spanish team yet (no request for Spanish team initiation yet)
  • This PR includes files in content/es/*

So, I think the spellchecker configuration for Spanish content would be better to be managed (configured) after a Spanish team is established with their own branch.
@JasonMorgan @CathPag what do you think so?

- '**.md'
- '!.github/*'
branches:
- main
Copy link
Collaborator

Choose a reason for hiding this comment

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

Each localization team has (/will have) their own development branch (https://github.com/cncf/glossary/tree/dev-ko for Korean for instance). So, localization teams will not use main branch for localizing documents. We need to add development branch if a localization team wants to use this spellchecker in workflow.

@electrocucaracha
Copy link
Collaborator Author

* Each localization team supposed to use their own development branch (ex: dev-pt)

@seokho-son another approach could be the creation of GitHub workflows per language. This requires multiple spellcheck configuration files but the major benefit is granular control. I can change this PR to reflect that idea.

@JasonMorgan
Copy link
Collaborator

Based on requirements we have around permissions we already need to do unique branches for each language. Happy to try whatever approach as long as the spellchecks can safely run on their respective branches.

@JasonMorgan JasonMorgan added the enhancement New feature or request label Feb 4, 2022
@electrocucaracha
Copy link
Collaborator Author

I have created this PR for the Spanish localization team where includes the changes required by the spellchecker. The drawback of using the rojopolis/spellcheck-github-actions is relying on the addition of dictionaries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants