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

TECHNICAL: add minimal validation testing #49

Open
stijn-dejongh opened this issue Feb 11, 2024 · 1 comment
Open

TECHNICAL: add minimal validation testing #49

stijn-dejongh opened this issue Feb 11, 2024 · 1 comment
Labels
help wanted Extra attention is needed status: stale Inactive issues and PRs. type: automation About actions workflows and automation. type: enhancement New feature or request.

Comments

@stijn-dejongh
Copy link
Member

Improve the deployment pipeline by adding in:

  • MarkDown syntax checks and style linting
  • Deployment checks using testing library
    • validate all links work
    • verify all tags have a page with relevant content
    • verify all books have a dedicated page
  • Automated grammar and spelling checks ( if possible )
@stijn-dejongh stijn-dejongh added type: enhancement New feature or request. help wanted Extra attention is needed type: automation About actions workflows and automation. labels Feb 11, 2024
@stijn-dejongh
Copy link
Member Author

Notes and Options

Validity checks

  • @Vankerkom has recommended the use of MS PlayWright to create the content validation.
  • An alternative is to use a regular JEST harnass, or go all out using a Selenium based implementation

Linting and Grammar check

  • Consider using OpenAI (or derivative) public API's to check the raw content
  • Alternative spellchecker could be something like CodeSpell
  • Linting can be done using MarkdownLint

@stijn-dejongh stijn-dejongh added the status: stale Inactive issues and PRs. label Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed status: stale Inactive issues and PRs. type: automation About actions workflows and automation. type: enhancement New feature or request.
Projects
None yet
Development

No branches or pull requests

1 participant