Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2209 commits
Select commit Hold shift + click to select a range
6ddd032
changelog: add parhds (#570)
davlgd Mar 19, 2025
f475464
fix: Paris DNS records
davlgd Mar 19, 2025
3cbd125
changelog: terraform provider update (#572)
davlgd Mar 20, 2025
80f1743
changelog: fix latest Terraform entry title
davlgd Mar 20, 2025
21d00fa
add-ons(metabase): add the password reset procedure
davlgd Mar 19, 2025
e9a3a1f
changelog: PHP version management update
davlgd Mar 21, 2025
34d4de4
changelog: Matomo 5.3.1
davlgd Mar 21, 2025
aaf905d
changelog: images update 2025 W12
davlgd Mar 24, 2025
881caba
Update 03-18-images-update-ruby-unified.md
davlgd Mar 24, 2025
6101850
addons: update index (#579)
davlgd Mar 24, 2025
534ab4c
applications(php): delete php.json instructions
davlgd Mar 21, 2025
7af2517
changelog: update on PG11/12 support
davlgd Mar 24, 2025
33bc8aa
changelog: Otoroshi update Biscuit Studio 0.10
davlgd Mar 24, 2025
b3c9d31
changelog: JS client 10.0.0
davlgd Mar 25, 2025
c6a125d
changelog: Python 3.8 EOL
davlgd Mar 25, 2025
73b332e
Change product support page (#584)
Kirbeerus Mar 25, 2025
71a5b70
fix: no more long titles in sidebar (#574)
cnivolle Mar 25, 2025
f56cf21
Fix broken link (#563)
guillaumecabanel Mar 25, 2025
dde9326
changelog: PG17 default
davlgd Mar 27, 2025
1912968
test fix redirect (#590)
davlgd Mar 27, 2025
7ba47dd
chore: fix dead links and aliases (#591)
davlgd Mar 27, 2025
6ac3f91
fix: typo in network-groups.md
gnoireaux Mar 28, 2025
068f127
docs(applications): add FrankenPHP
davlgd Mar 25, 2025
be33b9e
changelog: Frankenphp runtime
davlgd Mar 26, 2025
d6fe5bc
fix: images links (#593)
davlgd Mar 28, 2025
3ebd71d
changelog: Keycloak 26.1.4
davlgd Mar 28, 2025
af75961
doc: add "With Apache" for PHP/Static runtimes (#596)
davlgd Mar 28, 2025
b70bb42
pm_2025_03_03: complete with dbaas actions (#552)
aurrelhebert Apr 1, 2025
843ae50
docs(env vars): update Redirection.io agent availability (#586)
davlgd Apr 1, 2025
cf827c9
changelog: Clever Kubernetes Operator v0.7.0
davlgd Apr 1, 2025
64f1b4c
changelog: images update 2025 W13
davlgd Apr 3, 2025
df7e212
changelog: Otoroshi 17
davlgd Apr 2, 2025
a47b4f2
changelog: PostgreSQL replication update
davlgd Apr 2, 2025
f1ff275
addons(postgresql): add replication section
davlgd Apr 2, 2025
f6efc28
fix: typos, missing lines/spaces
davlgd Apr 3, 2025
613f135
applications(php): add SQLSRV extensions references
davlgd Apr 3, 2025
5d8658d
docs(envvars): add reference to TAILSCALE_ACCEPT_DNS, TAILSCALE_ACCEP…
davlgd Apr 3, 2025
7924dc4
changelog: images update 2025 W14
davlgd Apr 3, 2025
3087eb9
changelog: PostgreSQL locale
davlgd Apr 4, 2025
73f3683
api: update network groups endpoints information
davlgd Apr 2, 2025
7e3963b
Add Versioning tutorial for Cellar with AWS CLI and MinIO (#516)
Kirbeerus Apr 8, 2025
ed5e5bb
fix: remove dead links (#597)
davlgd Apr 9, 2025
ad4d575
addons(mysql): update MySQL version data
davlgd Apr 11, 2025
20b3df4
changelog: MySQL 8.4.4-4
davlgd Apr 11, 2025
e407904
chore: rename Clever Operator to Clever K8S Operator (#555)
davlgd Apr 15, 2025
dcfbd9f
feat(workflow): add Links checker (#609)
davlgd Apr 15, 2025
1cfba76
applications(php): remove pm.max_children section
sebartyr Apr 16, 2025
65857d5
guides(kubernetes-operator): fix redirection alias
davlgd Apr 16, 2025
968aec1
guides: fix Kubernetes Operator link
davlgd Apr 16, 2025
1608f79
changelog: update recent Kubernetes Operator links
davlgd Apr 16, 2025
0637c44
changelog: images update, 2025W16
davlgd Apr 16, 2025
2cb7a25
docs(envvars): fix TAILSCALE_ACCEPT_ROUTES
Kirbeerus Apr 16, 2025
a2da70b
changelog: Metabase 54
davlgd Apr 22, 2025
abafd60
changelog: update operators NG endpoint
davlgd Apr 23, 2025
dd1d4f3
changelog: update Metabase 54
davlgd Apr 23, 2025
1b2c267
changelog: Keycloak 26.2.1
davlgd Apr 25, 2025
d91e044
addons(keycloak): updates from 26.2.1 release
davlgd Apr 25, 2025
623f7ec
changelog: typo
davlgd Apr 25, 2025
dc6f8e9
changelog: Otoroshi with Biscuit Studio 0.0.13
davlgd Apr 25, 2025
1e2a1ff
fix(ci-cd): Console URL (#617)
davlgd Apr 25, 2025
18252eb
fix: bad links removal (#618)
davlgd Apr 25, 2025
fa834c1
workflow: update linkchecker command (#619)
davlgd Apr 25, 2025
6eb97f5
chore: update Hugo to 0.146.7, Hextra to 0.9.7 (#622)
davlgd Apr 25, 2025
e652cdd
addons(mysql): mark MySQL 5.7 as EOL
davlgd Apr 25, 2025
d485672
applications(node): update default version
davlgd Apr 25, 2025
90d91ea
Enhance Kubernetes Operator guide with additional information (#626)
LostInBrittany Apr 30, 2025
8e4dd03
Doc : How to delete Matomo old archives (#625)
Kirbeerus May 6, 2025
54ebb1d
changelog: Redis 8.0
davlgd May 6, 2025
4db9bca
changelog: images update, 2025W19
davlgd May 6, 2025
260c51f
changelog: Node.js 24
davlgd May 6, 2025
4832083
changelog: 2505 Keycloak updates
davlgd May 13, 2025
4c97af0
fix(billing): invoice first section, image caption
May 13, 2025
dde526b
changelog: images update, 2025W20
davlgd May 13, 2025
64d995b
changelog: Otoroshi API service dependencies update
davlgd May 14, 2025
cbcfa6c
addons(otoroshi): URL updates
davlgd May 14, 2025
a35c9e9
changelog: typo in previous entries
davlgd May 15, 2025
56a81e6
changelog: Radis 8.0.1
davlgd May 15, 2025
0d7c1c2
applications(node): update version management
davlgd May 13, 2025
8221350
changeloge: CC_NODE_VERSION in Node.js runtime
davlgd May 19, 2025
125cc8b
changelog: images update, 2025W20-2
davlgd May 19, 2025
8d83201
data(runtime): update Node.js version
davlgd May 19, 2025
656ca6f
administrate(domaine names): add a mention of primary/favourite domain
davlgd May 19, 2025
bcca78a
changelog: Otoroshi v17.1
davlgd May 19, 2025
a864f42
addons(Otoroshi): add mention of audio, image and moderation models
davlgd May 19, 2025
dabe708
changelog: Matomo 5.3.2
davlgd May 20, 2025
314ccbc
changelog: fix Otoroshi 17.1.1 URL
davlgd May 20, 2025
5d00b1c
changelog: PostgreSQL 17.5-16.9-15.13-14.18-13.21
davlgd May 20, 2025
7bd82de
data(dedicated): update PostgreSQL versions
davlgd May 20, 2025
80b8f1a
changelog: new OAuth consumers interface
davlgd May 28, 2025
1016379
fix: default archetype date, to prevent vale error in CI (#643)
davlgd May 30, 2025
16745f6
applications(javascript): update frontmatters
davlgd Jun 2, 2025
2f95697
applications(node.js): update package.json section
davlgd Jun 2, 2025
e98cc57
applications(node.js): add Bun support
davlgd Jun 2, 2025
54d914f
applications(node.js): add Bun version
davlgd Jun 2, 2025
a571fd6
applications(node.js): reorganize sections, Vale fixes
davlgd Jun 2, 2025
9bbea5b
applications(javascript): update index menu
davlgd Jun 2, 2025
fca5055
changelog: bun native support
davlgd Jun 2, 2025
905e453
chore: Vale whitelist update
davlgd Jun 2, 2025
73d889f
applications(frankenphp): introduce CC_FRANKENPHP_PORT
davlgd Jun 2, 2025
136b187
applications(frankenphp): add custom user.ini, Caddyfile config instr…
davlgd Jun 2, 2025
e24e417
applications(frankenphp): updates FrankenPHP version
davlgd Jun 2, 2025
88773d9
changelog: images update, 2025W23
davlgd Jun 3, 2025
02d9c27
chore: Vale whitelist update
davlgd Jun 3, 2025
407a9e9
changelog: Redis 8.0.2
davlgd Jun 3, 2025
8b89006
reference(env vars): fix bad link for Node version
davlgd Jun 5, 2025
72125d3
reference(env vars): add a section for global version variables
davlgd Jun 5, 2025
0524f2e
reference(env vars): duplicate CC_NODE_VERSION for Node.js
davlgd Jun 5, 2025
3d7f4d3
changelog: Console sessions
davlgd Jun 5, 2025
bab443e
changelog: new OAuth tokens interface
davlgd Jun 5, 2025
26ce5ac
changelog: API tokens in Console with tips
davlgd Jun 5, 2025
c5fd7dd
doc: fix old tokens Console management page link
davlgd Jun 5, 2025
2942bd0
api(howto): add mention of API tokens management in Console
davlgd Jun 5, 2025
52dd9b1
web-components: link update
davlgd Jun 5, 2025
ce93a40
api(howto): add a mention of the API bridge in API tokens introduction
davlgd Jun 5, 2025
838d5e6
changelog: mysql 8.0.42 and 8.4.5
davlgd Jun 9, 2025
4682fd5
changelog: Clever Tools 3.13
davlgd Jun 2, 2025
22c89b5
cli: sync with Clever Tools 3.13 documentation
davlgd Jun 9, 2025
ba48a15
chore: update Clever Tools install instructions link
davlgd Jun 10, 2025
cda5dc3
chore: update Clever Tools documentation links
davlgd Jun 10, 2025
236cc0d
fix #641: Add mention that FS bucket cannot be created on Health regi…
cnivolle Jun 10, 2025
aa245a8
applications(nodejs): update deployment video (#642)
davlgd Jun 10, 2025
c807f79
chore: simplify deploy script
davlgd Jun 8, 2025
b1dd6b3
chore: adapt build workflow to new deploy script
davlgd Jun 8, 2025
20fdec1
changelog: Terraform 0.8
davlgd Jun 9, 2025
a365a37
changelog: Terraform 0.8
davlgd Jun 9, 2025
3d655a0
reference: update product Matrix
davlgd Jun 9, 2025
7025c5c
Fix typo table env var
Jun 11, 2025
e8ca887
changelog: images update, 2025W25
davlgd Jun 10, 2025
bdc00c9
applications(php): update CC_CGI_IMPLEMENTATION
davlgd Jun 10, 2025
c5fbc6c
reference(env vars): add CC_DOCKER_BUILDX
davlgd Jun 10, 2025
a0395cc
feat(php): add module opentelemetry
Jun 18, 2025
9ec4e07
applications(php): update extensions support list
davlgd Jun 19, 2025
c7c2872
changelog: Metabase 55
davlgd Jun 20, 2025
87cd75c
cli(operators): fix links, details
davlgd Jun 20, 2025
fdb8e99
changelog: Keycloak 26.2.5
davlgd Jun 20, 2025
2f88118
changelog: fix node version
davlgd Jun 23, 2025
391353c
guides: add oTree
wowi42 Jun 24, 2025
d5aba27
guides(oTree): add deployment instructions
davlgd Jun 27, 2025
a3e98d6
Fix typo
AlekSi Jun 27, 2025
7c2d0cd
changelog: Ionos London region
davlgd Jul 1, 2025
d961745
administrate(domain names): update order, add HDS notice
davlgd Jul 1, 2025
bfe1dbf
quickstart: fix typo
AlekSi Jun 27, 2025
3b327b2
fix: enhance links texts
davlgd Jun 5, 2025
92aad9b
changelog: images update, 2025W27
davlgd Jun 30, 2025
e75ba00
changelog: JS Client 11.0
davlgd Jul 2, 2025
ce50c71
changelog: Terraform 0.10.0
davlgd Jul 2, 2025
6c64736
doc: Docs guide (#587)
Jul 3, 2025
8f035c4
cli: auth-bridge > api-bridge
davlgd Jul 3, 2025
00c0c65
chore: add applications archetype
davlgd Jun 20, 2025
5ab821b
chore: add mise, redirection.io and varnish partials
davlgd Jun 20, 2025
724d6fe
chore: update applications links
davlgd Jun 20, 2025
94da148
administrate(cache): update Varnish
davlgd Jun 20, 2025
9d1e229
applications: add Linux
davlgd Jun 20, 2025
d10a6c8
applications: add Static
davlgd Jun 20, 2025
b4029e5
applications: add V
davlgd Jun 20, 2025
bdb2fc6
cli(applications): add new runtimes
davlgd Jun 20, 2025
f0a268d
changelog: fix 25W27 title
davlgd Jul 4, 2025
8becd55
changelog: Linux, Static, V runtimes
davlgd Jul 4, 2025
cb0f28f
chore: flexsearch configuration
davlgd Jul 2, 2025
64a6aeb
chore: add content shortcode
davlgd Jul 2, 2025
90e2f9c
chore: move to content shortcode
davlgd Jul 2, 2025
8372936
chore: vale rules sync
davlgd Jun 19, 2025
8685d22
chore: replace ... with …
davlgd Jul 4, 2025
dc0d41d
vale: add Clever ellipsis rule
davlgd Jul 4, 2025
95d9ecb
applications(static): fix Nuxt.js command/files
davlgd Jul 6, 2025
05ef2d1
applications(static): add mention of auto-build in optimized build ca…
davlgd Jul 6, 2025
3702fce
applications(static): fix link to Varnish documentation
davlgd Jul 6, 2025
e5c54ef
changelog: fix links to CLI doc
davlgd Jul 6, 2025
b89977c
changelog: fix link to Clever Tasks documentation
davlgd Jul 6, 2025
cc1d676
metrics(new-relic): update agent installation links
davlgd Jul 6, 2025
a8db299
guides: reorder and fix index links
davlgd Jul 6, 2025
ce394f9
chore: update icons with new runtimes
davlgd Jul 7, 2025
9bf2d04
applications: add new runtimes to index, update titles
davlgd Jul 7, 2025
5541b8b
applications: update index links
davlgd Jul 7, 2025
eae6ecf
quickstart: sync runtimes list
davlgd Jul 7, 2025
e014471
chore: update Hugo max supported version
davlgd Jul 9, 2025
0113cf1
fix: Elixir latest supported version
davlgd Jul 9, 2025
40a15c6
changelog: images update, 2025W28
davlgd Jul 8, 2025
ffc3631
chore: use Hugo 0.148 in build workflow
davlgd Jul 9, 2025
aa66654
chore: use static runtime in deploy workflow
davlgd Jul 9, 2025
b94c144
changelog: redis 8.0.3 with JSON
davlgd Jul 9, 2025
3fa872f
changelog: terraform 0.11.0
davlgd Jul 10, 2025
35e4c97
changelog: fix Redis JSON link
davlgd Jul 11, 2025
5f64748
docs(application): add an alias, update frontmatter
davlgd Jul 15, 2025
4221de7
chore: update doc old links
davlgd Jul 15, 2025
12d887d
chore: add a Vale rule for 'organisation'
davlgd Jul 10, 2025
6612136
fix: organization > organisation
davlgd Jul 10, 2025
fccdf0a
account(organisation): rename page, add alias, update links
davlgd Jul 15, 2025
5b7403a
account(administrate-organisation): rename page, add alias, update links
davlgd Jul 15, 2025
2be57e1
chore: remove folder when there is only an index in it
davlgd Jul 11, 2025
3752a35
chore: remove legacy extend section
davlgd Jul 11, 2025
1a884af
chore: move meteor/node to 1st level, adapt links
davlgd Jul 11, 2025
0c84b95
addon(pulsar): multiple fixes
gnoireaux Jul 15, 2025
181b0dd
chore: move glossary to tooltips and document it in README.md
davlgd Jul 10, 2025
1f1db13
applications(javascript): add alias to meteor/nodejs
davlgd Jul 15, 2025
5369c03
Update configuration.md
davlgd Jul 15, 2025
6af6e15
chore: clean aliases
davlgd Jul 15, 2025
5ba660f
fix(changelog): 2023/12-22-sozu-wider-usage path
davlgd Jul 15, 2025
70651fa
fix: 404 image URL, redirection link
davlgd Jul 16, 2025
af045ca
chore: remove unnecessary paddings/margin in 404.html
davlgd Jul 16, 2025
305ab4c
fix: add aliases
davlgd Jul 15, 2025
53e4359
docs: front matter update and fixes
davlgd Jul 15, 2025
0dcd935
fix: add aliases
davlgd Jul 16, 2025
75665b2
fix: add aliases
davlgd Jul 16, 2025
8857b99
fix: add aliases
davlgd Jul 16, 2025
3193485
chore: add remote shortcode
davlgd Jul 15, 2025
82956ce
chore: update content markdown shortcode
davlgd Jul 15, 2025
974fd4f
chore: update shortcode content
davlgd Jul 15, 2025
a8bbb57
changelog: Request Flow
davlgd Jul 17, 2025
934aa3b
docs(reference): add CLI reference and update script
davlgd Jul 15, 2025
92dce72
chore: update hugo.yaml
davlgd Jul 15, 2025
70a8d2b
applications(php): add a Note about FS Buckets in HDS regions
cnivolle Jul 15, 2025
eddaed0
addons(fs-bucket): move limitations to a dedicated section
cnivolle Jul 17, 2025
a02bd39
quickstart: add a Note about storage on immutable infrastructrure
cnivolle Jul 17, 2025
40b02ea
chore: remove unnecessary files
davlgd Jul 16, 2025
c341d76
chore: move shared content to shared folder
davlgd Jul 16, 2025
98a7cc2
chore: move drafts to drats folder
davlgd Jul 16, 2025
b1e9d9c
chore: move contribute section to contribute.md
davlgd Jul 16, 2025
dbb2ed6
chore: move all images to static/images
davlgd Jul 16, 2025
553c34e
chore: remove image shortcode
davlgd Jul 16, 2025
34124af
chore: remove img-grid shortcode
davlgd Jul 16, 2025
5fb26bf
fix: add aliases
davlgd Jul 17, 2025
296b345
Reunite v1/v2 documentations
davlgd Jul 17, 2025
707d5fa
chore: clean after documentation reunite
davlgd Jul 17, 2025
c76d8d3
fix: add aliases
davlgd Jul 18, 2025
145e4fa
chore: update add-ons/runtime versions
davlgd Jul 18, 2025
f573039
chore: update .gitignore
davlgd Jul 18, 2025
bc28979
chore: remove unused public/ submodule
davlgd Jul 18, 2025
959f19e
fix: callout syntax, don't use link/code in title
davlgd Jul 18, 2025
126240e
fix: add aliases
davlgd Jul 18, 2025
8d111a7
fix: add aliases
davlgd Jul 19, 2025
b73af49
cli: add operators to index cards
davlgd Jul 19, 2025
76ae9e9
fix: add aliases
davlgd Jul 19, 2025
630684c
fix: add aliases
davlgd Jul 19, 2025
8a7fb57
fix: add aliases
davlgd Jul 21, 2025
2e65bdc
fix: add aliases
davlgd Jul 22, 2025
22d6976
shortcodes(content): fix HTML entity escaping
LostInBrittany Jul 21, 2025
52ddde4
fix: add aliases
davlgd Jul 22, 2025
bc7ff40
fix: add aliases
davlgd Jul 23, 2025
4ded3a3
fix: add aliases
davlgd Jul 23, 2025
e111e53
fix: add aliases
davlgd Jul 24, 2025
a58b0f2
best-practices(tips_and_tricks): update Clever Components storybook link
davlgd Jul 24, 2025
58738f2
guides: use full path in index's cards
davlgd Jul 24, 2025
e9b3e49
chore: remove ref shortcode usage, update links
davlgd Jul 24, 2025
db1dce6
guides(play-framework-2): remove duplicate sentence
davlgd Jul 24, 2025
3c2a249
Guide deploy ghost
Jul 10, 2025
9782ba1
delete aliases
Jul 10, 2025
86c013b
Update content/guides/tutorial-ghost-blog.md
Juju-archy Aug 6, 2025
0c4ff57
Update content/guides/tutorial-ghost-blog.md
Juju-archy Aug 6, 2025
483fcfb
Update content/guides/tutorial-ghost-blog.md
Juju-archy Aug 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/new-content-form.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Suggest a new page or section
description: Suggest new content for the documentation
title: "Doc: "
labels: ["documentation"]
projects: "CleverCloud/10"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this new content form!
- type: checkboxes
id: existing-issue
attributes:
label: Checking for existing issue
description: Have you checked your request hasn't been already addressed in another issue?
options:
- label: I have checked for existing [issues](https://github.com/CleverCloud/documentation/issues)
required: true
- type: textarea
id: describe-content
attributes:
label: "Describe the content you'd like to see"
description: "A clear and concise description of what you want to happen."
placeholder: "I'd like to have a new page/section about…"
validations:
required: true
18 changes: 18 additions & 0 deletions .github/external-doc-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: External doc update from PR {{ env.PR_NUMBER }}
labels: documentation
---

## External documentation update needed

Update the external documentation:

- Author: @{{ payload.sender.login }}
- PR: {{ env.PR_URL }}
- Modified files: {{ env.CHANGED_FILES }}

Make a PR on one of these repositories:

- [Astro](https://github.com/withastro/docs)


14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Describe your PR

_Summarize your changes here : explain what, how, and why. Be as explicict as you can on why your changes are needed and avoid implicit reasoning._


## Checklist

- [ ] My PR is related to an opened issue : #
- [ ] I've read the [contributing guidelines](/CleverCloud/documentation/blob/main/CONTRIBUTING.md)


## Reviewers
_Who should review these changes?_ @CleverCloud/reviewers

10 changes: 10 additions & 0 deletions .github/styles/.vale-config/0-Hugo.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[*.md]
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
(\[.+\]\({{< .+ >}}\)), \
[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \
[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s

# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
8 changes: 8 additions & 0 deletions .github/styles/Clever/ellipsis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: substitution
message: "Use '…' (ellipsis character) instead of '%s'"
level: warning
ignorecase: false

# Replace three consecutive periods with proper ellipsis
swap:
'\.\.\.': '…'
9 changes: 9 additions & 0 deletions .github/styles/Clever/hyphens.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Write '%s' with hyphens when used as an adjective before a noun, but as separate words when it appears as a noun phrase or after a verb"
level: suggestion
ignorecase: true
tokens:
- 'up-to-date'
- 'up to date'
- 'end-of-life'
- 'end of life'
8 changes: 8 additions & 0 deletions .github/styles/Clever/organisation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: substitution
message: "Use 'organisation' instead of 'organization'"
level: error
ignorecase: true

swap:
organization: organisation
organizations: organisations
9 changes: 9 additions & 0 deletions .github/styles/Google/AMPM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Use 'AM' or 'PM' (preceded by a space)."
link: "https://developers.google.com/style/word-list"
level: error
nonword: true
tokens:
- '\d{1,2}[AP]M\b'
- '\d{1,2} ?[ap]m\b'
- '\d{1,2} ?[aApP]\.[mM]\.'
64 changes: 64 additions & 0 deletions .github/styles/Google/Acronyms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
extends: conditional
message: "Spell out '%s', if it's unfamiliar to the audience."
link: 'https://developers.google.com/style/abbreviations'
level: suggestion
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- API
- ASP
- CLI
- CPU
- CSS
- CSV
- DEBUG
- DOM
- DPI
- FAQ
- GCC
- GDB
- GET
- GPU
- GTK
- GUI
- HTML
- HTTP
- HTTPS
- IDE
- JAR
- JSON
- JSX
- LESS
- LLDB
- NET
- NOTE
- NVDA
- OSS
- PATH
- PDF
- PHP
- POST
- RAM
- REPL
- RSA
- SCM
- SCSS
- SDK
- SQL
- SSH
- SSL
- SVG
- TBD
- TCP
- TODO
- URI
- URL
- USB
- UTF
- XML
- XSS
- YAML
- ZIP
8 changes: 8 additions & 0 deletions .github/styles/Google/Colons.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: existence
message: "'%s' should be in lowercase."
link: 'https://developers.google.com/style/colons'
nonword: true
level: warning
scope: sentence
tokens:
- '(?<!:[^ ]+?):\s[A-Z]'
30 changes: 30 additions & 0 deletions .github/styles/Google/Contractions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: 'https://developers.google.com/style/contractions'
level: suggestion
ignorecase: true
action:
name: replace
swap:
are not: aren't
cannot: can't
could not: couldn't
did not: didn't
do not: don't
does not: doesn't
has not: hasn't
have not: haven't
how is: how's
is not: isn't
it is: it's
should not: shouldn't
that is: that's
they are: they're
was not: wasn't
we are: we're
we have: we've
were not: weren't
what is: what's
when is: when's
where is: where's
will not: won't
9 changes: 9 additions & 0 deletions .github/styles/Google/DateFormat.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Use 'July 31, 2016' format, not '%s'."
link: 'https://developers.google.com/style/dates-times'
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
- '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'
9 changes: 9 additions & 0 deletions .github/styles/Google/Ellipses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "In general, don't use an ellipsis."
link: 'https://developers.google.com/style/ellipses'
nonword: true
level: warning
action:
name: remove
tokens:
- '\.\.\.'
13 changes: 13 additions & 0 deletions .github/styles/Google/EmDash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Don't put a space before or after a dash."
link: "https://developers.google.com/style/dashes"
nonword: true
level: error
action:
name: edit
params:
- trim
- " "
tokens:
- '\s[—–]\s'

12 changes: 12 additions & 0 deletions .github/styles/Google/Exclamation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
extends: existence
message: "Don't use exclamation points in text."
link: "https://developers.google.com/style/exclamation-points"
nonword: true
level: error
action:
name: edit
params:
- trim_right
- "!"
tokens:
- '\w+!(?:\s|$)'
13 changes: 13 additions & 0 deletions .github/styles/Google/FirstPerson.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Avoid first-person pronouns such as '%s'."
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
ignorecase: true
level: warning
nonword: true
tokens:
- (?:^|\s)I\s
- (?:^|\s)I,\s
- \bI'm\b
- \bme\b
- \bmy\b
- \bmine\b
9 changes: 9 additions & 0 deletions .github/styles/Google/Gender.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Don't use '%s' as a gender-neutral pronoun."
link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
level: error
ignorecase: true
tokens:
- he/she
- s/he
- \(s\)he
43 changes: 43 additions & 0 deletions .github/styles/Google/GenderBias.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
link: "https://developers.google.com/style/inclusive-documentation"
level: error
action:
name: replace
swap:
(?:alumna|alumnus): graduate
(?:alumnae|alumni): graduates
air(?:m[ae]n|wom[ae]n): pilot(s)
anchor(?:m[ae]n|wom[ae]n): anchor(s)
authoress: author
camera(?:m[ae]n|wom[ae]n): camera operator(s)
door(?:m[ae]|wom[ae]n): concierge(s)
draft(?:m[ae]n|wom[ae]n): drafter(s)
fire(?:m[ae]n|wom[ae]n): firefighter(s)
fisher(?:m[ae]n|wom[ae]n): fisher(s)
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
lady lawyer: lawyer
ladylike: courteous
mail(?:m[ae]n|wom[ae]n): mail carriers
man and wife: husband and wife
man enough: strong enough
mankind: human kind|humanity
manmade: manufactured
manpower: personnel
middle(?:m[ae]n|wom[ae]n): intermediary
news(?:m[ae]n|wom[ae]n): journalist(s)
ombuds(?:man|woman): ombuds
oneupmanship: upstaging
poetess: poet
police(?:m[ae]n|wom[ae]n): police officer(s)
repair(?:m[ae]n|wom[ae]n): technician(s)
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
service(?:m[ae]n|wom[ae]n): soldier(s)
steward(?:ess)?: flight attendant
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
waitress: waiter
woman doctor: doctor
woman scientist[s]?: scientist(s)
work(?:m[ae]n|wom[ae]n): worker(s)
13 changes: 13 additions & 0 deletions .github/styles/Google/HeadingPunctuation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: existence
message: "Don't put a period at the end of a heading."
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
nonword: true
level: warning
scope: heading
action:
name: edit
params:
- trim_right
- "."
tokens:
- '[a-z0-9][.]\s*$'
29 changes: 29 additions & 0 deletions .github/styles/Google/Headings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
level: warning
scope: heading
match: $sentence
indicators:
- ":"
exceptions:
- Azure
- CLI
- Cosmos
- Docker
- Emmet
- gRPC
- I
- Kubernetes
- Linux
- macOS
- Marketplace
- MongoDB
- REPL
- Studio
- TypeScript
- URLs
- Visual
- VS
- Windows
- JSON
11 changes: 11 additions & 0 deletions .github/styles/Google/Latin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: 'https://developers.google.com/style/abbreviations'
ignorecase: true
level: error
nonword: true
action:
name: replace
swap:
'\b(?:eg|e\.g\.)(?=[\s,;])': for example
'\b(?:ie|i\.e\.)(?=[\s,;])': that is
Loading