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.

Sign up for GitHub

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

Jump to bottom

Integrate Vale for linting docs according to editorial style guide #3566

Closed
dhruvkb opened this issue Sep 3, 2023 · 2 comments · Fixed by #3567
Closed

Integrate Vale for linting docs according to editorial style guide #3566

dhruvkb opened this issue Sep 3, 2023 · 2 comments · Fixed by #3567
Assignees
@sarayourfriend
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: mgmt Related to repo management and automations

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Sep 3, 2023

Description

We can integrate Vale (https://github.com/errata-ai/vale) into the pre-commit hooks to ensure that our documentation has a consistent style guide that can be enforced. Vale has a significant number of stars on GitHub, seems actively maintained and supports pre-commit.

This is related to #368.
@dhruvkb dhruvkb added good first issue New-contributor friendly help wanted Open to participation from the community labels Sep 3, 2023
@sarayourfriend
Copy link
Collaborator

Oh this is an excellent find. It's exactly what I was hoping for by suggesting LanguageTool integration!

@ngken0995 ngken0995 mentioned this issue Sep 26, 2023
Closed
4 tasks
@sarayourfriend
Copy link
Collaborator

Note that we are changing the approach to implementing this and will now create a docker image in the sensitive terms repo to avoid introducing sensitive terms into the repository. More information can be found in the discussion in #3065.

A new tracking issue for the work blocking this issue is here: WordPress/openverse-sensitive-terms#6

@sarayourfriend sarayourfriend mentioned this issue Nov 1, 2023
Open
4 tasks
@sarayourfriend sarayourfriend transferred this issue from WordPress/openverse Nov 16, 2023
@sarayourfriend sarayourfriend transferred this issue from WordPress/openverse-sensitive-terms Dec 21, 2023
@openverse-bot openverse-bot moved this from ⛔ Blocked to 📋 Backlog in Openverse Backlog Dec 21, 2023
@sarayourfriend sarayourfriend mentioned this issue Dec 21, 2023
Merged
7 tasks
@sarayourfriend sarayourfriend self-assigned this Dec 21, 2023
@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: mgmt Related to repo management and automations 🧱 stack: documentation Related to Sphinx documentation labels Dec 21, 2023
@openverse-bot openverse-bot moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Dec 21, 2023
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog Dec 21, 2023
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sarayourfriend sarayourfriend

Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: mgmt Related to repo management and automations
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
2 participants
@dhruvkb @sarayourfriend