mwinters/docs-team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

Link text added to vale linter

Browse source
This commit is contained in:
hank L 2023-05-13 18:29:23 +00:00 • committed by Peter Boy
commit 3149ea0bf3
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
modules/ROOT/pages/contributing-docs/tools-web-ide-ui.adoc
View file

@ -1,6 +1,6 @@
= How to profoundly use GitLab UI for document maintenance
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revdate: 2023-03-22
:revdate: 2023-05-13
[abstract]
Documentation needs maintainance as the content grows. Writers and reviewers can contribute to Docs easily and efficiently inside GitLab Web User Interface. From Web IDE, CI pipeline to collaborative review of rendered web content and approval of pages, you can work on good content and document maintenance, uninterrupted by installation and configuration. The article assumes you are already familiar with Git and continuous integration (CI).
@ -45,9 +45,9 @@ image::gitlab-ui/commit.png[]
Automated test for Docs triggers syntax validation, stylistic errors, and helps fix them before MR is merged. The goals are project-wide consistency of documentation and adherence to the style guides. Docs team introduced a syntax-aware documentation linter for a few repos where you can find vale configuration files. Some contributors write articles without a knowledge of style guides and readability. Refer to the vale linter configuration for CI in the relevant repos:
- https://gitlab.com/fedora/docs/community-tools/documentation-contributors-guide/-/tree/main/.vale/styles/RedHat
- https://gitlab.com/fedora/docs/community-tools/documentation-contributors-guide/-/tree/main/.vale/styles/RedHat[Contributor Guides]
- https://gitlab.com/fedora/docs/docs-website/pages/-/tree/main/.vale/styles/RedHat
- https://gitlab.com/fedora/docs/docs-website/pages/-/tree/main/.vale/styles/RedHat[Docs Home Page]
Documentation linter carries out more than 20 tests: