Skip to content

Commit 18ae41d

Browse files
bszymanbszyman
committed
Merge remote-tracking branch 'origin/extension-types-pr' into extension-types-pr
# Conflicts: # 16/umbraco-cms/customizing/extending-overview/extension-types/README.md
2 parents f838b10 + 2521056 commit 18ae41d

File tree

5,300 files changed

+4281
-190382
lines changed

Some content is hidden

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

5,300 files changed

+4281
-190382
lines changed

‎.github/styles/UmbracoDocs/Acronyms.yml‎

Lines changed: 117 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,123 @@
1+
---
12
extends: conditional
2-
message: "'%s' has no definition"
3-
level: error
3+
message: "'%s' has no definition."
4+
description: >
5+
Ensures that all acronyms used in the documentation are clearly defined.
6+
link: https://docs.umbraco.com/contributing/documentation/style-guide#acronyms
47
scope: text
8+
level: error
59
ignorecase: false
6-
# Ensures that the existence of 'first' implies the existence of 'second'.
7-
# Require leading whitespace to avoid matching on URL substrings eg https://www.youtube.com/embed/OUD-PbWESAs?rel=0
10+
# If an uppercase acronym of 3-5 letters is found (first),
11+
# require a definition (second) somewhere nearby.
812
first: '\b([A-Z]{3,5})\b'
913
second: '([A-Z]{3,5}): (?:\b[A-Z][a-z]+ )+|(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
10-
# ... with the exception of these:
14+
# ... with the exception of these. Sorted alphabetically for easier maintenance.
1115
exceptions:
12-
- ABC
13-
- ADD
14-
- ALT
15-
- HTML
16-
- JSON
17-
- CSS
18-
- API
19-
- URL
20-
- UDI
21-
- URI
22-
- NET
23-
- MVC
24-
- GET
25-
- ASP
26-
- ADO
27-
- REST
28-
- HTTP
29-
- HTTPS
30-
- CURL
31-
- BASE
32-
- UDA
33-
- CLI
34-
- KUDU
35-
- XML
36-
- PATH
37-
- SQL
38-
- SHIFT
39-
- POST
40-
- GUID
41-
- UWP
42-
- HAL
43-
- LINK
44-
- DLL
45-
- CMS
46-
- ONLY
47-
- IIS
48-
- DNS
49-
- DOM
50-
- XSLT
51-
- AJAX
52-
- YAML
53-
- PNG
54-
- ISO
55-
- PDF
56-
- DXP
57-
- FAQ
58-
- DIBS
59-
- VAT
60-
- SKU
61-
- UTC
62-
- HEX
63-
- RGBA
64-
- IDE
65-
- CPU
66-
- RAM
67-
- CNAME
68-
- AAAA
69-
- TXT
70-
- PUT
71-
- DELETE
72-
- ZIP
73-
- CTRL
74-
- SPACE
75-
- ENTER
76-
- VIP
77-
- DEBUG
78-
- INFO
79-
- TEMP
80-
- GIF
81-
- GDPR
82-
- NPM
83-
- SVG
84-
- DHL
85-
- UUI
86-
- MDN
87-
- JPG
88-
- JPEG
89-
- BCC
90-
- SSD
91-
- ASCII
92-
- CMD
93-
- NGINX
16+
- AAAA # IPv6 address record (DNS)
17+
- ADD #
18+
- ADO # ActiveX Data Objects
19+
- AJAX # Asynchronous JavaScript and XML
20+
- ALT # Alternative text (images)
21+
- API # Application Programming Interface
22+
- ASCII # American Standard Code for Information Interchange
23+
- ASP # Active Server Pages
24+
- BCC # Blind Carbon Copy (email)
25+
- CD # Continuous Delivery
26+
- CDN # Content Delivery Network
27+
- CI # Continuous Integration
28+
- CLI # Command Line Interface
29+
- CMD # Command (Windows shell)
30+
- CMS # Content Management System
31+
- CPU # Central Processing Unit
32+
- CSS # Cascading Style Sheets
33+
- CTRL # Control (Keyboard key)
34+
- CURL # Client URL
35+
- DELETE # HTTP DELETE method
36+
- DHL # International Shipping brand
37+
- DIBS # DIBS by Nets
38+
- DNS # Domain Name System
39+
- DOM # Document Object Model
40+
- DXP # Digital Experience Platform
41+
- EOL # End of Life
42+
- FAQ # Frequently Asked Questions
43+
- FTP # File Transfer Protocol
44+
- GDPR # General Data Protection Regulation
45+
- GET # HTTP GET method
46+
- GIF # Graphics Interchange Format
47+
- GUI # Graphical user interface
48+
- GUID # Globally Unique Identifier
49+
- HAL # Hypertext Application Language
50+
- HASH # Cryptographic hash
51+
- HEX # Hexadecimal
52+
- HTML # HyperText Markup Language
53+
- HTTP # HyperText Transfer Protocol
54+
- HTTPS # HyperText Transfer Protocol Secure
55+
- IaaS # Infrastructure as a Service
56+
- IDE # Integrated Development Environment
57+
- IIS # Internet Information Services
58+
- INFO # Information
59+
- ISO # International Organization for Standardization
60+
- JPG # Joint Photographic Experts Group
61+
- JPEG # Joint Photographic Experts Group
62+
- JSON # JavaScript Object Notation
63+
- JSONP # JSON with Padding
64+
- JS # JavaScript
65+
- JWT # JSON Web Token
66+
- KUDU # Azure deployment engine
67+
- LDAP # Lightweight Directory Access Protocol
68+
- LINK #
69+
- MIT # Open-source software license developed at the Massachusetts Institute of Technology (MIT)
70+
- MDN # Mozilla Developer Network
71+
- MFA # Multi-factor Authentication
72+
- MVC # Model-View-Controller
73+
- NET # .NET Framework
74+
- NGINX # Engine X (web server)
75+
- NPM # Node Package Manager
76+
- OAuth # Open Authorization
77+
- ONLY #
78+
- ORM # Object-Relational Mapping
79+
- PaaS # Platform as a Service
80+
- PATH # file system path
81+
- PDF # Portable Document Format
82+
- PNG # Portable Network Graphics
83+
- POST # HTTP POST method
84+
- PUT # HTTP PUT method
85+
- RAM # Random Access Memory
86+
- REST # Representational State Transfer
87+
- RGBA # Red Green Blue Alpha (color model)
88+
- RPG # Role-Playing Game
89+
- RTX # Ray Tracing Texel eXtreme (NVIDIA tech)
90+
- SaaS # Software as a Service
91+
- SDK # Software Development Kit
92+
- SEO # Search Engine Optimization
93+
- SHIFT # Keyboard key
94+
- SPACE # Keyboard key
95+
- SKU # Stock Keeping Unit
96+
- SMTP # Simple Mail Transfer Protocol
97+
- SQL # Structured Query Language
98+
- SSD # Solid State Drive
99+
- SSL # Secure Sockets Layer
100+
- SVG # Scalable Vector Graphics
101+
- TCP # Transmission Control Protocol
102+
- TEMP # Temporary
103+
- TS # TypeScript
104+
- TXT # Text (file format)
105+
- TLS # Transport Layer Security
106+
- UDA # Files for Umbraco project's metadata
107+
- UDI # Unique Device Identifier
108+
- UI # User Interface
109+
- URI # Uniform Resource Identifier
110+
- URL # Uniform Resource Locator
111+
- UTC # Coordinated Universal Time
112+
- UUID # Universally Unique Identifier
113+
- UWP # Universal Windows Platform
114+
- UX # User Experience
115+
- VAL #
116+
- VAT # Value-Added Tax
117+
- VIP # Very Important Person
118+
- WYSIWYG # What You See Is What You Get
119+
- XML # Extensible Markup Language
120+
- XSLT # Extensible Stylesheet Language Transformations
121+
- XSS # Cross-Site Scripting
122+
- YAML # YAML file
123+
- ZIP # ZIP file format

‎.github/styles/UmbracoDocs/Brands.yml‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
11
---
22
extends: substitution
3-
message: "We prefer %s over '%s.'"
3+
message: "Use '%s' instead of '%s' for brand consistency."
4+
description: >
5+
Ensures consistent capitalization of brand and product names.
6+
This rule ignores matches inside markdown links and inline code to prevent false warnings.
7+
link: https://docs.umbraco.com/contributing/documentation/style-guide#brands
48
level: warning
9+
scope: text
10+
ignorecase: true
11+
# Sorted alphabetically for easier maintenance.
512
swap:
6-
'(?<![\.\/])youtube': "'YouTube'"
7-
microsoft: "'Microsoft'"
8-
slack: "'Slack'"
9-
azure: "'Azure'"
10-
gitbook: "'GitBook'"
11-
Gitbook: "'GitBook'"
12-
github: "'GitHub'"
13-
Github: "'GitHub'"
13+
# Use negative lookbehind to ignore matches inside markdown links `[text](link)` or inline code `code`
14+
'(?<![\[`(])\bazure\b(?![.\w/-]*\))': "Azure"
15+
'(?<![\[`])\bazure devops\b': "Azure DevOps"
16+
'(?<![\[`])\bchrome\b': "Chrome"
17+
'(?<![\[`])\bcloudflare\b': "Cloudflare"
18+
'(?<![\[`])\bfirefox\b': "Firefox"
19+
'(?<![\[`\/\.])\bgitbook\b': "GitBook"
20+
'(?<![\[`])\bgithub\b': "GitHub"
21+
'(?<![\[`])\bmacos\b': "macOS"
22+
'(?<![\[`(])\bmicrosoft\b(?![.\w/-]*\))': "Microsoft"
23+
'(?<![\[`])\bnginx\b': "NGINX"
24+
'(?<![\[`])\bsafari\b': "Safari"
25+
'(?<![\[`])\bslack\b': "Slack"
26+
'(?<![\[`])\btwitter\b': "Twitter"
27+
'(?<![\[`])\bumbraco id\b': "Umbraco ID"
28+
'(?<![\[`])\bumbraco support\b': "Umbraco Support"
29+
'(?<![\[`])\bvisual studio code\b': "Visual Studio Code"
30+
'(?<![\[`])\bvs code\b': "Visual Studio Code"
31+
'(?<![\[`])\byoutube\b(?![-\.\/])': "YouTube"

‎.github/styles/UmbracoDocs/Editorializing.yml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
---
1+
---
22
extends: existence
3-
message: "Consider removing '%s'"
4-
ignorecase: true
3+
message: "Consider removing '%s' as it can be considered opinionated."
4+
description: >
5+
Flags words and phrases that express opinion, exaggeration, or assumptions. These can make documentation feel biased, subjective, or unclear.
6+
link: https://docs.umbraco.com/contributing/documentation/style-guide#avoid-punctuation-in-headings
57
level: warning
8+
ignorecase: true
9+
# Sorted alphabetically for easier maintenance.
10+
# Uses regex patterns with \b for whole word matching.
11+
# The pattern for 'simple' excludes common technical terms to reduce false positives.
612
tokens:
713
- actually
814
- aptly
@@ -37,7 +43,7 @@ tokens:
3743
- remarkably
3844
- several
3945
- significantly
40-
- simple
46+
- '\bsimple\b(?! (Mail|Message|Object|Protocol|Transfer|Markup))'
4147
- simply
4248
- substantially
4349
- surprisingly

‎.github/styles/UmbracoDocs/HeadingsPunctuation.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
extends: existence
3-
message: Do not use '%s' at the end of headings
4-
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
3+
message: "Do not use '%s' at the end of heading."
4+
description: >
5+
Checks headings to ensure they do not end with punctuation.
6+
link: https://docs.umbraco.com/contributing/documentation/style-guide#avoid-punctuation-in-headings
57
scope: heading
68
level: warning
79
raw:
8-
- '(?:\:|\.)$'
10+
- '(?:[.:;!…])$'

‎.github/styles/UmbracoDocs/LinkTextClarity.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
extends: existence
3+
message: "Avoid generic link text like '%s'. Use descriptive link text instead."
4+
description: >
5+
Descriptive link text improves accessibility and SEO by clearly indicating
6+
where the link leads, rather than using vague terms.
7+
level: warning
8+
ignorecase: true
9+
scope: raw
10+
nonword: true
11+
tokens:
12+
- '\[\s*here\s*\]'
13+
- '\[\s*click here\s*\]'
14+
- '\[\s*read more\s*\]'
15+
- '\[\s*more info\s*\]'

‎.github/styles/UmbracoDocs/ListStart.yml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
---
12
extends: existence
2-
message: "Start each option with a capital letter."
3-
link: https://github.com/testthedocs/vale-styles/blob/master/OpenStack/ListStart.yml
4-
level: warning
3+
message: "List items should start with a capital letter, unless they begin with an inline code or a URL."
4+
description: >
5+
Ensures that each list item starts with a capital letter,
6+
unless the item begins with inline code or a URL.
7+
link: https://docs.umbraco.com/contributing/documentation/style-guide#use-lists-when-listing-more-than-2-items-steps
58
scope: list
9+
level: warning
610
nonword: true
711
tokens:
8-
- '^[a-z].+'
12+
- '^(?!\[|_)[a-z].+'

‎.github/styles/UmbracoDocs/Names.yml‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1+
---
12
extends: substitution
2-
message: "We prefer %s over '%s'"
3+
message: "Use '%s' instead of '%s' for consistency."
4+
description: >
5+
Ensures consistent capitalization and formatting of common terms and acronyms.
6+
link: https://docs.umbraco.com/contributing/documentation/style-guide#names
37
level: warning
8+
scope: paragraph
49
swap:
5-
'(?:(?<!\.)css)': CSS
6-
'(?:(?<!\.)[hH]tml)': HTML
7-
"url(?!=)": "'URL'"
8-
'(?:(?<!\.)js|[jJ]ava[sS]cript)': JavaScript
9-
'(?:(?<!\.)ts|[tT]ype[sS]cript)': TypeScript
10-
.net: "'.NET'"
11-
dot net: "'.NET'"
12-
cms: "'CMS'"
13-
"[aA]ngular[jJ][sS]": AngularJS
14-
SUITS: "'Sales'"
10+
'\bcss\b(?!/)': CSS
11+
'(?<!\.)[hH]tml': HTML
12+
'url(?!=)': URL
13+
'(?:(?<!\.)js|[jJ]ava[sS]cript)': JavaScript
14+
'(?:(?<!\.)ts|[tT]ype[sS]cript)': TypeScript
15+
'.net': .NET
16+
'dot net': .NET
17+
'\bcms\b': CMS
18+
'[aA]ngular[jJ][sS]': AngularJS
19+
'SUITS': Sales

‎.github/styles/UmbracoDocs/Repetition.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
extends: repetition
3+
message: "'%s' is repeated."
4+
description: >
5+
Detects repeated words like 'the the'.
6+
alpha: true
7+
level: warning
8+
tokens:
9+
- '[^\s]+'
10+

‎.github/styles/UmbracoDocs/SentenceLength.yml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
message: "Write shorter sentences (less than 25 words)."
1+
---
22
extends: occurrence
3+
message: "Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content."
4+
description: >
5+
Shorter sentences improve readability and clarity in documentation.
6+
To avoid false positives in note or warning tags, add blank lines around the block content.
7+
link: https://docs.umbraco.com/contributing/documentation/style-guide#avoid-long-sentences
38
scope: sentence
49
level: warning
510
max: 25

0 commit comments

Comments
 (0)