Skip to content

Commit f653ac1

Browse files
jounirusselljtdyer
andauthored
Refactor contributing guides and update DSP docs (#2373)
Co-authored-by: russelljtdyer <6652767+russelljtdyer@users.noreply.github.com>
1 parent f4fc7ff commit f653ac1

File tree

125 files changed

+3585
-9119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+3585
-9119
lines changed

.github/styles/Vaadin/AMPM.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
extends: existence
22
message: "Use 'a.m.' or 'p.m.' (preceded by a space)."
3-
link: http://vaadin.com/docs/latest/contributing-docs/style-guide/word-list/#a-m-p-m
43
level: warning
54
nonword: true
65
tokens:

.github/styles/Vaadin/Abbr.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
extends: conditional
22
message: "'%s' has no definition."
3-
link: http://vaadin.com/docs/latest/contributing-docs/style-guide/grammar/#abbreviations
43
level: warning
54
scope: text
65
ignorecase: false

.github/styles/Vaadin/AdmonitionTitle.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# NOTE: The annotation appears two lines above the offending admonition (Vale limitation)
22
extends: existence
33
message: 'Admonitions should have a title.'
4-
link: http://vaadin.com/docs/latest/contributing-docs/style-guidelines/#admonitions
4+
link: http://vaadin.com/docs/contributing/docs/styleguide#admonitions
55
level: suggestion
66
scope: raw
77
nonword: true

.github/styles/Vaadin/Admonitions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: occurrence
22
message: 'Avoid using more than 3 admonitions per article.'
3-
link: http://vaadin.com/docs/latest/contributing-docs/style-guidelines/#admonitions
3+
link: http://vaadin.com/docs/contributing/docs/styleguide#admonitions
44
level: suggestion
55
scope: raw
66
ignorecase: false

.github/styles/Vaadin/ComplexWords.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
extends: substitution
22
message: "Consider using '%s' instead of '%s'."
3-
link: http://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
43
ignorecase: true
54
level: suggestion
65
action:

.github/styles/Vaadin/Contractions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: substitution
22
message: "Use '%s' instead of '%s'."
3-
link: http://vaadin.com/docs/latest/contributing-docs/style-guide/style#contractions
3+
link: vaadin.com/docs/contributing/docs/styleguide/style#contractions
44
level: suggestion
55
ignorecase: true
66
action:

.github/styles/Vaadin/CrossReference.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: existence
22
message: "Don't use absolute URLs for cross references within documentation."
3-
link: http://vaadin.com/docs/latest/contributing-docs/formatting/#xrefs
3+
link: http://vaadin.com/docs/contributing/docs/styleguide/#xrefs
44
nonword: true
55
level: error
66
scope: raw

.github/styles/Vaadin/EN_US.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: existence
22
message: "In general, use American spelling instead of '%s'."
3-
link: 'http://developers.google.com/style/spelling'
3+
link: http://vaadin.com/docs/contributing/docs/styleguide#english
44
ignorecase: true
55
level: warning
66
tokens:

.github/styles/Vaadin/Ellipses.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
extends: existence
22
message: "In general, don't use an ellipsis."
3-
link: http://docs.microsoft.com/en-us/style-guide/punctuation/ellipses
43
nonword: true
54
level: warning
65
action:

.github/styles/Vaadin/Exclamation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extends: existence
22
message: 'Avoid using exclamation points in text.'
3-
link: http://vaadin.com/docs/latest/contributing-docs/style-guide/style/#exclamation-mark
3+
link: http://vaadin.com/docs/contributing/docs/styleguide#exclamations
44
nonword: true
55
level: warning
66
tokens:

0 commit comments

Comments
 (0)