Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
df95da4d
Commit
df95da4d
authored
Jan 25, 2022
by
Evan Read
Committed by
Marcel Amirault
Jan 25, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add how to update linter configuration in projects
parent
d822a30a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
0 deletions
+18
-0
doc/development/documentation/testing.md
doc/development/documentation/testing.md
+18
-0
No files found.
doc/development/documentation/testing.md
View file @
df95da4d
...
...
@@ -126,6 +126,24 @@ If you don't want to install all of the dependencies to test the links, you can:
If you manually install
`haml-lint`
with this process, it does not update automatically
and you should make sure your version matches the version used by GitLab.
## Update linter configuration
[
Vale configuration
](
#vale
)
and
[
markdownlint configuration
](
#markdownlint
)
is under source control in each
project, so updates must be committed to each project individually.
We consider the configuration in the
`gitlab`
project as the source of truth and that's where all updates should
first be made.
On a regular basis, the changes made in
`gitlab`
project to the Vale and markdownlint configuration should be
synchronized to the other projects. In
`omnibus-gitlab`
,
`gitlab-runner`
, and
`charts/gitlab`
:
1.
Create a new branch.
1.
Copy the configuration files from the
`gitlab`
project into this branch, overwriting
the project's old configuration. Make sure no project-specific changes from the
`gitlab`
project are included. For example,
[
`RelativeLinks.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/RelativeLinks.yml
)
is hard coded for specific projects.
1.
Create a merge request and submit it to a technical writer for review and merge.
## Local linters
To help adhere to the
[
documentation style guidelines
](
styleguide/index.md
)
, and improve the content
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment