NEW Add documentation linting option #112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 tasks
emteknetnz
requested changes
Apr 4, 2024
README.md
Outdated
| @@ -75,6 +75,10 @@ Create a smaller matrix with only the lowest supported PHP and MySQL versions in | |||
| Dynamically generate a matrix using feature detection. If disabled, jobs must be defined using the extra_jobs input. Default is true, disable with: | |||
| `dynamic_matrix: false` | |||
|
|
|||
| ##### Documentation linting | |||
| Runs linting against documentation using [silverstripe/documentation-lint](https://github.com/silverstripe/documentation-lint/) if the `.ss-docs-lint` config file is available. Default is true, disable with: | |||
There was a problem hiding this comment.
Suggested change
| Runs linting against documentation using [silverstripe/documentation-lint](https://github.com/silverstripe/documentation-lint/) if the `.ss-docs-lint` config file is available. Default is true, disable with: | |
| Runs linting against documentation using [silverstripe/documentation-lint](https://github.com/silverstripe/documentation-lint/) if the `.doclintrc` config file is available. Default is true, disable with: |
GuySartorelli
force-pushed
the
pulls/1/new-docs-linting
branch
from
eaa035b
to
f187a0f
Compare
emteknetnz
approved these changes
Apr 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds an option to opt out of documentation linting - not sure why anyone would since it's only added if you have the relevant config file, but this mirrors what we're doing with other things like php linting so makes sense to just keep with the way we're doing those.
Issues