You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--
Thank you for contributing to the Elastic Docs! 🎉
Use this template to help us efficiently review your contribution.
-->
## Summary
<!--
Describe what your PR changes or improves.
If your PR fixes an issue, link it here. If your PR does not fix an
issue, describe the reason you are making the change.
-->
## Generative AI disclosure
<!--
To help us ensure compliance with the Elastic open source and
documentation guidelines, please answer the following:
-->
1. Did you use a generative AI (GenAI) tool to assist in creating this
contribution?
- [ ] Yes
- [X] No
<!--
2. If you answered "Yes" to the previous question, please specify the
tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).
Tool(s) and model(s) used:
-->
Copy file name to clipboardExpand all lines: contribute-docs/vale-linter.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ navigation_title: Vale linter
4
4
5
5
# Elastic style guide for Vale
6
6
7
-
[Vale](https://github.com/errata-ai/vale) is a prose linter that checks documentation in Markdown format against the [Elastic style guide](/contribute-docs/style-guide/index.md). The Elastic documentation is checked against the style guide when you commit changes to a pull request.
7
+
[Vale](https://github.com/errata-ai/vale) is a prose linter that checks documentation in Markdown format against the [Elastic style guide](/contribute-docs/style-guide/index.md). The documentation is checked when you commit changes to a pull request.
8
8
9
9
Follow the instructions on this page to:
10
10
@@ -13,7 +13,7 @@ Follow the instructions on this page to:
13
13
14
14
## Vale checks in pull requests [vale-checks-in-pull-requests]
15
15
16
-
The Vale action for GitHub runs Vale checks on pull requests that include documentation changes. The action report any style issues found in modified lines in the form of a sticky comment.
16
+
The Vale action for GitHub runs Vale checks on pull requests that include documentation changes. The action reports any style issues found in modified lines in the form of a sticky comment.
17
17
18
18
:::{image} ./images/vale-sticky-comment.png
19
19
:alt: Vale comment in pull request
@@ -70,9 +70,7 @@ To update the Elastic style guide to the latest rules, rerun the installation sc
70
70
:::::
71
71
72
72
:::::{step} Install the IDE extension
73
-
Install the [Vale VSCode](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) extension to view Vale checks when saving a document.
74
-
75
-
The extension is also available for other editors that support the Open VSX Registry, like Cursor.
73
+
Install the [Vale VSCode](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) extension. The extension is also available for other editors that support the Open VSX Registry, like Cursor.
0 commit comments