Skip to content

Remove no longer necessary Vale steps

Marcin Sedlak-Jakubowski requested to merge msj-vale-doc into master

What does this MR do?

In !53030 (comment 498492359) I added steps to the Documentation testing page. I needed to follow them to configure the Vale VS Code extension. Today it looks like my extension works properly even if I remove the explicitly added path to vale.ini and the binary. We can instead point at the instructions in the extension Readme.

I also updated the link to Vale Server, as the previous article must have been moved, though I couldn't find it.

Related issues

#300656 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports

Loading