Skip to content

Commit 8a1ca80

Browse files
authored
Edits to Vale docs (#4229)
<!-- 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: -->
1 parent b9b18d5 commit 8a1ca80

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

contribute-docs/vale-linter.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ navigation_title: Vale linter
44

55
# Elastic style guide for Vale
66

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.
88

99
Follow the instructions on this page to:
1010

@@ -13,7 +13,7 @@ Follow the instructions on this page to:
1313

1414
## Vale checks in pull requests [vale-checks-in-pull-requests]
1515

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.
1717

1818
:::{image} ./images/vale-sticky-comment.png
1919
:alt: Vale comment in pull request
@@ -70,9 +70,7 @@ To update the Elastic style guide to the latest rules, rerun the installation sc
7070
:::::
7171

7272
:::::{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.
7674
:::::
7775

7876
:::::{step} Open any Markdown file

0 commit comments

Comments
 (0)